Skip to content
Snippets Groups Projects
Unverified Commit a4fe0d07 authored by Brent Huisman's avatar Brent Huisman Committed by GitHub
Browse files

Improved doc index, link Python install instructions for quick setup (#1112)

Guide Python users to the Python installation steps early in the installation guide.
parent 6fcc06c9
No related branches found
No related tags found
No related merge requests found
......@@ -6,7 +6,7 @@ Arbor is a library for implementing performance portable network simulations of
An installation guide and library documentation are available online at [Read the Docs](http://arbor.readthedocs.io/en/latest/).
[Submit a ticket](https://github.com/arbor-sim/arbor) if you have any questions or want help.
[Submit a ticket or start a discussion](https://github.com/arbor-sim/arbor) if you have any questions or want help.
### Citing Arbor
......
......@@ -6,13 +6,12 @@ Arbor
What is Arbor?
--------------
Arbor is a high-performance library for computational neuroscience simulations, being developed in work package 7.5.4 of the `Human Brain Project <//www.humanbrainproject.eu>`_.
Arbor is a high-performance library for computational neuroscience simulations.
The development team is based in:
The development team is from from high-performance computing (HPC) centers:
* Swiss National Supercomputing Center (CSCS), Jülich and BSC in work package 7.5.4 of the HBP.
* Aim to prepare neuroscience users for new HPC architectures;
* `Swiss National Supercomputing Center <//www.cscs.ch>`_ (CSCS)
* `Jülich Supercomputing Centre <//www.fz-juelich.de/ias/jsc/EN/>`_ (JSC)
Arbor is designed from the ground up for **many core** architectures:
......@@ -87,7 +86,7 @@ Alternative citation formats for the paper can be `downloaded here <https://ieee
.. toctree::
:caption: Python:
py_intro
py_common
py_recipe
......
......@@ -3,8 +3,10 @@
Installing Arbor
################
Arbor is installed by obtaining the source code and compiling it on
the target system.
.. Note::
If you want to get started quickly experimenting with Arbor via its Python wrapper, see the Python installation guide at :doc:`/python`.
This guide covers installing Arbor using CMake, which is the recommended method for configuring Arbor for HPC applications and developers.
This guide starts with an overview of the building process, and the various options
available to customize the build.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment