Documentation using Jupyter notebook

[AtsushiSakai]

.ipynb file may be good for documentation of each algorithm.

[v-node]

I can help with jupyter notebook for each algorithm.

[AtsushiSakai]

@node-py Thank you for your interest. Are you familiar with any algorithm in this repo?. If you are, I would like you to write a document with .ipynb file.

[kartikmadhira1]

I have too implemented similar codes taking help from some of the codes in the Repo so I can help too. Can you be more specific regarding the documentation? As in to add in-depth text (math, diagrams, etc.) to each block of code or just superficially explain as to what each block of code does?

[AtsushiSakai]

@kartikmadhira1 Thank you for your comment. Yes, it is great to include it's math, algorithm, and diagram. I think code description is not needed because there are comments on the code. If you read the doc and code, you can understand the basic idea of the algorithm. This is the goal of this project.

[kartikmadhira1]

@AtsushiSakai Sure then. I'll try to get a first draft version on Astar and Dijkstra and present it to you. Will try to get it done by end of next week.

[AtsushiSakai]

@kartikmadhira1 Oh. great. I appreciate your help!!.

[AtsushiSakai]

I'm trying to write a jupyter notebook for MPC.
PythonRobotics/notebook.ipynb at master · AtsushiSakai/PythonRobotics

• finish jupyter notebook for MPC

[tsaoyu]

You might already know there is a nbviewer provided by jupyter project. It have better math rendering than GitHub native one e.g. this. When most notebooks are ready, binder gives an interactive environment for the user to execute those notebooks.

[kartikmadhira1]

@AtsushiSakai I am working on writing documentation regarding Kalman Filters- concepts and math with examples from a few sources. We can add it to the EKF section if you want.

[AtsushiSakai]

@kartikmadhira1 Nice. Could you make PR?

[AtsushiSakai]

MPC's notebook is done. Next one is EKF.

• PythonRobotics/notebook.ipynb at master · AtsushiSakai/PythonRobotics

[nithin1995]

Hi, I am interested to contribute. I am new to this field, and interested to learn and contribute. I would like you suggest an algorithm for me to start working on the documentation.

[AtsushiSakai]

@nithin1995 Thank you. How about EKF? PythonRobotics/notebook.ipynb at master · AtsushiSakai/PythonRobotics