File: index.rst

package info (click to toggle)
prrte 4.0.1-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 9,108 kB
  • sloc: ansic: 81,373; sh: 4,289; perl: 3,150; makefile: 1,878; python: 610; lex: 352
file content (46 lines) | stat: -rw-r--r-- 1,166 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
PMIx Reference Runtime Environment (PRRTE) |prte_ver|
=====================================================

The project is formally referred to in documentation by "PRRTE", and
the GitHub repository is ``prrte``.

.. note:: We have found that most users do not like typing the two
          consecutive ``r`` letters in the name. Hence, all of the
          internal API symbols, environment variables, MCA frameworks,
          and CLI executables all use the abbreviated ``prte`` (one
          ``r``, not two) for convenience.

Documentation locations
=======================

This documentation can be found in the following locations:

* On the web: https://docs.prrte.org/
* In the tarball: ``docs/_build/html/index.html``
* Installed: ``$prefix/share/doc/prrte/html/index.html``

Table of contents
=================

.. toctree::
   :maxdepth: 2
   :numbered:

   quickstart
   release-notes
   getting-help
   install
   configuration
   terminology
   how-things-work/index
   hosts/index
   placement/index
   launching-apps/index
   notifications
   session-directory
   developers/index
   contributing
   license
   man/index
   versions
   news/index