Skip to content

Commit 337d58a

Browse files
authored
Merge pull request ComputationalRadiationPhysics#2519 from ax3l/doc-startInstallPath
Docs: Stream-line Intro
2 parents a9c8fee + a453a94 commit 337d58a

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

docs/source/index.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@
1010
*A particle-in-cell code for GPGPUs*
1111

1212
PIConGPU is a fully relativistic, many GPGPU, 3D3V particle-in-cell (PIC) code.
13-
The Particle-in-Cell algorithm is a central tool in plasma physics.
13+
The PIC algorithm is a central tool in plasma physics.
1414
It describes the dynamics of a plasma by computing the motion of electrons and ions in the plasma based on Maxwell's equations.
1515

1616
How to Read This Document
1717
-------------------------
1818

19-
Generally, you want to follow those pages in-order to get started.
19+
Generally, **follow the manual pages in-order** to get started.
2020
Individual chapters are based on the information of the chapters before.
21-
2221
In case you are already fluent in compiling C++ projects and HPC, running PIC simulations or scientific data analysis feel free to jump the respective sections.
2322

24-
.. attention::
25-
This documentation is just getting started.
26-
Learn more about how to improve it :ref:`here <development-sphinx>` and please contribute via pull requests! :-)
23+
.. only:: html
24+
25+
The online version of this document is **versioned** and shows by default the manual of the last *stable* version of PIConGPU.
26+
If you are looking for the latest *development* version, `click here <https://picongpu.readthedocs.io/en/latest/>`_.
27+
2728

28-
.. note::
29-
We also have a `wiki`_
30-
and a general `official homepage`_
29+
We are migrating our `wiki`_ to this manual, but some pages might still be missing.
30+
We also have an `official homepage`_ .
3131

3232
.. _wiki: https://github.com/ComputationalRadiationPhysics/picongpu/wiki
3333
.. _official homepage: http://picongpu.hzdr.de

docs/source/install/path.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,23 @@ The first part is usually the job of a system administrator while the second par
1111
Depending on your experience, role, computing environment and expectations for optimal hardware utilization, you have several ways to install and select PIConGPU's dependencies.
1212
Choose your favorite *install and environment management method* below, young padavan, and follow the corresponding sections of the next chapters.
1313

14-
Before you Start
15-
----------------
14+
Ways to Install
15+
---------------
16+
17+
Choose *one* of the install methods below to get started:
18+
19+
Load Modules
20+
^^^^^^^^^^^^
21+
22+
On HPC systems and clusters, software is usually provided by system administrators via a module system (e.g. [modules]_, [Lmod]_).
23+
In case our :ref:`software dependencies <install-dependencies>` are available, we usually create a file in our ``$HOME`` named :ref:`<queueName>_picongpu.profile <install-profile>`.
24+
It loads according modules and sets :ref:`helper environment variables <install-dependencies-picongpu>`.
1625

1726
.. important::
1827

1928
For many HPC systems we already prepared and maintain an environment for you which will run out-of-the-box.
2029
See if yours is :ref:`in the list <install-profile>` so you can skip the installation completely!
2130

22-
Ways to Install
23-
---------------
24-
2531
Spack
2632
^^^^^
2733

0 commit comments

Comments
 (0)