Skip to content
Snippets Groups Projects
Ben Cumming's avatar
Benjamin Cumming authored
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.
23a24b5a

CI status Build Status codecov Gitpod Ready-to-Code

Arbor Library

Arbor is a library for implementing performance portable network simulations of multi-compartment neuron models.

An installation guide and library documentation are available online at Read the Docs.

Submit a ticket or start a discussion if you have any questions or want help.

Citing Arbor

The Arbor software can be cited via Zenodo: DOI.

Previous versions of Arbor can be cited specifically:

  • Version 0.2: DOI
  • Version 0.1: DOI

The following BibTeX entry can be used to cite Arbor:

@INPROCEEDINGS{
    paper:arbor2019,
    author={N. A. {Akar} and B. {Cumming} and V. {Karakasis} and A. {Küsters} and W. {Klijn} and A. {Peyser} and S. {Yates}},
    booktitle={2019 27th Euromicro International Conference on Parallel, Distributed and Network-Based Processing (PDP)},
    title={{Arbor --- A Morphologically-Detailed Neural Network Simulation Library for Contemporary High-Performance Computing Architectures}},
    year={2019}, month={feb}, volume={}, number={},
    pages={274--282},
    doi={10.1109/EMPDP.2019.8671560},
    ISSN={2377-5750}}

Alternative citation formats for the paper can be downloaded here, and a preprint is available at arXiv.