Welcome to the documentation for Arbor, the multi-compartment neural network simulation library.
You can find out how to :ref:`get Arbor<in_install>`; get started quickly with our :ref:`tutorials<gs_other_examples>`; or continue reading to learn more about Arbor.
What is Arbor?
-------------
Arbor is a high-performance library for computational neuroscience simulations with multi-compartment, morphologically-detailed cells,
from single cell models to very large networks. Arbor is written from the ground up with many-cpu and gpu architectures in mind, to
help neuroscientists effectively use contemporary and future HPC systems to meet their simulation needs.
...
...
@@ -13,6 +20,14 @@ When coupled with low memory overheads, this makes Arbor an order of magnitude f
Arbor is open source and openly developed, and we use development practices such as unit testing, continuous integration, and validation.
Documentation organisation
--------------------------
* :ref:`gs_other_examples` contains a few ready-made examples you can use to quickly get started using Arbor. In the tutorial descriptions we link to the relevant Arbor concepts.
* :ref:`modelintro` describes the design and concepts used in Arbor. The breakdown of concepts is mirrored (as much as possible) in the :ref:`pyoverview` and :ref:`cppoverview`, so you can easily switch between languages and concepts.
* :ref:`hpc-overview` details Arbor-features for distribution of computation over supercomputer nodes.
* :ref:`internals-overview` describes Arbor code that is not user-facing; convenience classes, architecture abstractions, etc.
Citing Arbor
------------
...
...
@@ -30,6 +45,15 @@ Citing Arbor
Alternative citation formats for the paper can be `downloaded here <https://ieeexplore.ieee.org/abstract/document/8671560>`_, and a preprint is available at `arXiv <https://arxiv.org/abs/1901.07454>`_.
Acknowledgements
----------------
This research has received funding from th European Unions Horizon 2020 Framework Programme for Research and
Innovation under the Specific Grant Agreement No. 720270 (Human Brain Project SGA1), and Specific Grant Agreement
No. 785907 (Human Brain Project SGA2).
Arbor is an `eBrains project <https://ebrains.eu/service/arbor/>`_.
You can find some examples of full Arbor simulations in the ``python/examples`` directory of the `Arbor repository <https://github.com/arbor-sim/arbor>`_. Note that some examples use ``pandas`` and ``seaborn`` for analysis and plotting which are expected to be installed independently from Arbor.
