Known issues in dqrobotics lessons¶
- Originally, the lessons written in
MATLABdid not allow the use of latex macros. This means that the conversion from those to Jupyter notebooks brought notation as-is, which is not entirely compliant with the latest notation. This is a very time-consuming task, so it will only be attempted with community support or further funding sources. - The current
plotmethod usingdqrobotics-pyplotin the Jupyter notebook is generating a phantom image besides the animation videos. There are instructions online that allow us to tackle this issue, but I haven’t been able to find one that properly shows the video but not the image. - The latex macros in all lessons do not seem to render well in
jupyterlab. It’s not yet clear to me why.
Text-based notebooks¶
- Converting from traditional Jupyter notebooks to text-based notebooks might be an interesting topic to explore. See
link. Classic notebooks
store cell output on themselves, with implications on version control software. While classic Jupyter notebooks are more
easily usable without extensions,
jupytextseemingly allows for the conversions. See link. - The so-called paired notebooks are possibly the solution.
Given that the latex macros sometimes do not render well in
jupyterlab, this could become indirectly a solution. The latex support formystis much less hacky, so it is likely that the notebooks exported from the text version are more likely to be compatible withjupyterlab.
Notes¶
jupyterbook2documentation is at https://next .jupyterbook .org.