-
- Downloads
Python Documentation PR (#687)
Update documentation for Python.
splits the conceptual model ideas from the C++ docs into their own section
has C++ and Python docs for recipes, domain decomposition, etc.
fixes #667
Added the following documentation (structure):
GETTING STARTED:
Installing Arbor/Requirements/Optional Requirements/Python
Installing Arbor/Building and Installing Arbor/Python Front End
MODEL BASICS:
Overview
Common Types
Recipes
Domain Decomposition
Simulations
PYTHON:
Overview
Common Types
Recipes
Domain Decomposition
Simulations
DEVELOPERS:
Python Profiler
Python Unit Testing
GETTING STARTED has two added sections of optional requirements using python and how to build the python front end.
MODEL BASICS describes Arbor's concepts in general (independent of programming language), thus general information on concepts in C++ API was moved here/ added.
PYTHON describes Arbor's python frontend in the same structure as MODEL BASICS and C++ API ( needs updates as soon as features are added/changed in new python PR).
DEVELOPERS section has two added sections for meter management and unit testing with python front end.
Further, some corrections in existing documentation (for obvious errors, e.g. duplicate text, not ending sentences) and referencing sections were done.
Showing
- doc/Rasterplot 0 additions, 0 deletionsdoc/Rasterplot
- doc/cpp_common.rst 2 additions, 0 deletionsdoc/cpp_common.rst
- doc/cpp_domdec.rst 1 addition, 3 deletionsdoc/cpp_domdec.rst
- doc/cpp_intro.rst 2 additions, 0 deletionsdoc/cpp_intro.rst
- doc/cpp_recipe.rst 3 additions, 9 deletionsdoc/cpp_recipe.rst
- doc/cpp_simulation.rst 1 addition, 0 deletionsdoc/cpp_simulation.rst
- doc/index.rst 21 additions, 1 deletiondoc/index.rst
- doc/install.rst 42 additions, 0 deletionsdoc/install.rst
- doc/library.rst 2 additions, 0 deletionsdoc/library.rst
- doc/model_common.rst 44 additions, 0 deletionsdoc/model_common.rst
- doc/model_domdec.rst 34 additions, 0 deletionsdoc/model_domdec.rst
- doc/model_intro.rst 25 additions, 0 deletionsdoc/model_intro.rst
- doc/model_recipe.rst 48 additions, 0 deletionsdoc/model_recipe.rst
- doc/model_simulation.rst 29 additions, 0 deletionsdoc/model_simulation.rst
- doc/py_common.rst 91 additions, 0 deletionsdoc/py_common.rst
- doc/py_domdec.rst 282 additions, 0 deletionsdoc/py_domdec.rst
- doc/py_overview.rst 48 additions, 0 deletionsdoc/py_overview.rst
- doc/py_profiler.rst 91 additions, 0 deletionsdoc/py_profiler.rst
- doc/py_recipe.rst 232 additions, 0 deletionsdoc/py_recipe.rst
- doc/py_simulation.rst 214 additions, 0 deletionsdoc/py_simulation.rst
Loading
Please sign in to comment