Skip to content
Snippets Groups Projects
Ben Cumming's avatar
Benjamin Cumming authored
Revert a change introduced in #1282 that required the python module for arbor to build the documentation.

This breaks the readthedocs build, where arbor is not available.

* Remove arbor dependence from `doc/conf.py`, reverting to the original "out of core" approach
* Fix other recently introduced issues that lead to CMake errors when configuring the documentation
  when the Python target is not configured.
  * The CMake variable `PYTHON_EXECUTABLE` wasn't set, but was required to make calls to the
     Python interpreter.
  * Instead of relying on pybind11 to find Python, explicitly detect it using `find_package(Python3 ...)`
  * Make Python3 a hard requirement when building the Python wrapper
  * And a soft requirement otherwise, that will fail only when the docs are built.
d326f2ea

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.