Open brenthuisman opened 3 years ago
Please keep the tutorials and examples as pure Python files in addition. Maybe https://github.com/brian-team/brian2-binder/blob/master/generate_notebooks.py can serve as a blue print.
Regarding EBRAINS: The point of source could be https://ebrains-cls-interactive.github.io/online-use-cases.html BUT: user needs access/account on EBRAINS
Jupyter-JSC could also be an alternative, BUT access the JSC resources is also needed.
Regarding Linkage of docs and tutorials:
Option 1: Extract text and code from notebook to generate documentation. Option 2: Remove the tutorials from the docs, and refer to the dir with notebooks on Github. Github will render them and we can add a link in the notebooks that lets you execute them on binder etc.
For running the tests, we need to extract code from notebooks (nb-convert
).
Additionally to binder, we could have a look at voila as well to turn Jupyter notebooks into standalone web applications.
Cf. https://github.com/electronicvisions/brainscales2-demos where sphinx documentation is converted to jupyter notebooks.
Thanks for the link, Sebastian. From flying over it I could see that
Comment from Padraig Gleeson in dev meet:
Lennart Landsmeer shares IO notebook on LFPy: https://github.com/llandsmeer/iopublic/blob/main/Local%20field%20potential%20v2.ipynb
.py
to maintain having them checked by CI