diff --git a/README.md b/README.md index 59fd442a878e26264a05f941a3a874de78e21f21..c61e614673004a1256b752f430b1edf77f71689e 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/doc/index.rst b/doc/index.rst index 6f4e7339f16aeb443cf7071f9fa3fe8003d05b05..47c519435ac86e080f96115f5631987a7e583156 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 diff --git a/doc/install.rst b/doc/install.rst index b35184701835f99813ada3b72698bc6e1b30e005..87ba36c7daa1057c7400f7cda333212dc092b132 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -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.