-
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
1f4eacd2
cpp_common.rst 4.31 KiB
Common Types
Cell Identifiers and Indexes
These types, defined in common_types.hpp, are used as identifiers for
cells and members of cell-local collections.
Note
Arbor uses std::unit32_t for :cpp:type:`cell_gid_type`,
:cpp:type:`cell_size_type`, :cpp:type:`cell_lid_type`, and
:cpp:type:`cell_local_size_type` at the time of writing, however
this could change, e.g. to handle models that cell gid that don't
fit into a 32 bit unsigned integer.
It is thus recommended that these type aliases be used whenever identifying
or counting cells and cell members.