Pydoc (#1122)
This PR adds a bunch of high-level docs for concepts related to single cell models. * morphologies * labels (region and locset expressions) * mechanisms * cable cells It adds some python scripts to the `doc` path, which are called during documentation building to generate images of cell morphologies, regions and locsets that are generated in a separate script that uses the Arbor Python API. The docs are not complete: the cable cell and mechanism docs are unfinished, and the tutorial section needs to build on these concepts to give more detailed step by step examples.
Showing
- .gitignore 3 additions, 0 deletions.gitignore
- .readthedocs.yml 14 additions, 0 deletions.readthedocs.yml
- doc/cable_cell.rst 388 additions, 0 deletionsdoc/cable_cell.rst
- doc/conf.py 30 additions, 1 deletiondoc/conf.py
- doc/index.rst 9 additions, 0 deletionsdoc/index.rst
- doc/labels.rst 762 additions, 0 deletionsdoc/labels.rst
- doc/mechanisms.rst 479 additions, 0 deletionsdoc/mechanisms.rst
- doc/morphology.rst 855 additions, 0 deletionsdoc/morphology.rst
- doc/nmodl.rst 79 additions, 0 deletionsdoc/nmodl.rst
- doc/py_cable_cell.rst 0 additions, 69 deletionsdoc/py_cable_cell.rst
- doc/py_common.rst 0 additions, 15 deletionsdoc/py_common.rst
- doc/py_hardware.rst 1 addition, 5 deletionsdoc/py_hardware.rst
- doc/py_recipe.rst 0 additions, 4 deletionsdoc/py_recipe.rst
- doc/py_simulation.rst 1 addition, 1 deletiondoc/py_simulation.rst
- doc/requirements.txt 2 additions, 0 deletionsdoc/requirements.txt
- doc/scripts/gen-labels.py 243 additions, 0 deletionsdoc/scripts/gen-labels.py
- doc/scripts/inputs.py 132 additions, 0 deletionsdoc/scripts/inputs.py
- doc/scripts/make_images.py 285 additions, 0 deletionsdoc/scripts/make_images.py
- doc/scripts/representation.py 184 additions, 0 deletionsdoc/scripts/representation.py
- doc/single_cell.rst 126 additions, 37 deletionsdoc/single_cell.rst
Please register or sign in to comment