Developers Guide

Here we document internal components of Arbor. These pages can be useful if you’re interested in developing on Arbor itself.

Arbor dependency graph. To see what dependencies Arbor has and how to generate this figure, see Dependency management.

Arbor Developers Guide:

• How the Cable Cell is made
  • Terminology
  • Setting up a Cable Cell simulation
  • Lowered Cells, Shared State, and the Discretisation
  • Main integration loop
• Cell groups
  • Cable Cell group mc_cell_group
• Matrix Solvers
  • Cable Equation
  • CPU
  • GPU
• SIMD Classes
  • Classes
  • Top-level functions
  • Implementation requirements
  • Missing functionality
  • Implementation of vector transcendental functions
• Shared State
  • Ions
  • Mechanisms
  • Further Functionality
• Exporting Symbols
  • Macro Description
• Adding Built-in Catalogues to Arbor
• Mechanism ABI
  • Metadata: arb_mechanism_type
  • Interlude: Parameter packs
  • Implementation: arb_mechanism_interface
  • SIMDization
  • Making A Loadable Mechanism
  • Writing Mechanisms Directly Against the ABI
• Utility wrappers and containers