Python wrapper: documentation (#799)
Add docs for Python wrapper to ReadTheDocs: - Overview, Common Types, Hardware Management, Recipes, Domain Decomposition, Simulations, Metering - Installing Arbor: Optional Requirements (Python), Buidling and Installing (Python Frontend), and Installation (Python Module) Missing (, since not implemented yet): - probes - arbor-sup - hint maps in domain_decomposition - reset, events, empty schedule in event_generator Also does not cover unit testing (since doc is user-centric). Makes also defaults and units in wrapper consistent. Fixes #766
Showing
- doc/cpp_common.rst 2 additions, 1 deletiondoc/cpp_common.rst
- doc/cpp_domdec.rst 3 additions, 3 deletionsdoc/cpp_domdec.rst
- doc/cpp_hardware.rst 10 additions, 10 deletionsdoc/cpp_hardware.rst
- doc/cpp_recipe.rst 1 addition, 1 deletiondoc/cpp_recipe.rst
- doc/cpp_simulation.rst 4 additions, 4 deletionsdoc/cpp_simulation.rst
- doc/index.rst 9 additions, 0 deletionsdoc/index.rst
- doc/install.rst 4 additions, 4 deletionsdoc/install.rst
- doc/model_domdec.rst 1 addition, 0 deletionsdoc/model_domdec.rst
- doc/model_hardware.rst 1 addition, 1 deletiondoc/model_hardware.rst
- doc/model_intro.rst 5 additions, 5 deletionsdoc/model_intro.rst
- doc/model_recipe.rst 2 additions, 1 deletiondoc/model_recipe.rst
- doc/model_simulation.rst 2 additions, 1 deletiondoc/model_simulation.rst
- doc/py_cable_cell.rst 75 additions, 0 deletionsdoc/py_cable_cell.rst
- doc/py_common.rst 80 additions, 0 deletionsdoc/py_common.rst
- doc/py_domdec.rst 122 additions, 0 deletionsdoc/py_domdec.rst
- doc/py_hardware.rst 238 additions, 0 deletionsdoc/py_hardware.rst
- doc/py_intro.rst 51 additions, 0 deletionsdoc/py_intro.rst
- doc/py_profiler.rst 106 additions, 0 deletionsdoc/py_profiler.rst
- doc/py_recipe.rst 378 additions, 0 deletionsdoc/py_recipe.rst
- doc/py_simulation.rst 177 additions, 0 deletionsdoc/py_simulation.rst
Please register or sign in to comment