From 92fdf6c50197ead3f61916def347642c320b05eb Mon Sep 17 00:00:00 2001
From: Brent Huisman <brenthuisman@users.noreply.github.com>
Date: Mon, 30 Nov 2020 17:18:21 +0100
Subject: [PATCH] Docs frontpage elaboration
* An explanation of documentation structure.
* Added HBP/Ebrains to acknowledgements.
---
doc/hpc/index.rst | 2 ++
doc/index.rst | 24 ++++++++++++++++++++++++
doc/internals/index.rst | 2 ++
doc/tutorial/index.rst | 4 ++--
4 files changed, 30 insertions(+), 2 deletions(-)
diff --git a/doc/hpc/index.rst b/doc/hpc/index.rst
index bc9527d5..dd39d7d5 100644
--- a/doc/hpc/index.rst
+++ b/doc/hpc/index.rst
@@ -1,3 +1,5 @@
+.. _hpc-overview:
+
HPC
===
diff --git a/doc/index.rst b/doc/index.rst
index de274d7b..79b70113 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -4,6 +4,13 @@ Arbor
.. image:: https://travis-ci.org/arbor-sim/arbor.svg?branch=master
:target: https://travis-ci.org/arbor-sim/arbor
+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/>`_.
+
.. toctree::
:caption: Arbor documentation:
:maxdepth: 1
diff --git a/doc/internals/index.rst b/doc/internals/index.rst
index 94f53a6f..2044b739 100644
--- a/doc/internals/index.rst
+++ b/doc/internals/index.rst
@@ -1,3 +1,5 @@
+.. _internals-overview:
+
Internals
=========
diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst
index fe79125c..0c57a0c3 100644
--- a/doc/tutorial/index.rst
+++ b/doc/tutorial/index.rst
@@ -1,7 +1,7 @@
.. _gs_other_examples:
-Quick start
-================================
+Tutorials
+=========
.. Note::
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.
--
GitLab