# PMIx Reference Runtime Environment (PRRTE) v4.1.1rc2

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

- 1. Quick start
- 2. Release Notes
- 3. Getting help
- 4. Installing PRRTE
  - 4.1. For More Information
  - 4.2. Minimum PMIx version
  - 4.3. Developer Builds
  - 4.4. User Builds
- 5. PRRTE DVM Configuration
  - 5.1. Configuration Options
  - 5.2. Configurator Tool
- 6. Terminology
- 7. How Things Work
  - 7.1. Session Directories
  - 7.2. Scheduler Integration
- 8. Host specification
  - 8.1. Resource Manager-Provided Hosts
  - 8.2. Hostfiles
  - 8.3. Listing Hosts on the Command Line
  - 8.4. Relative host indexing
- 9. Process placement
  - 9.1. Overview
  - 9.2. Definition of ‘slot’
  - 9.3. Definition of “processor element”
  - 9.4. Examples
  - 9.5. Fundamentals
  - 9.6. Overloading and Oversubscribing
  - 9.7. Diagnostics
  - 9.8. Rankfiles
  - 9.9. Deprecated options
- 10. Launching applications
  - 10.1. Quick start: Launching applications
  - 10.2. Prerequisites
  - 10.3. Placing processes across hosts
  - 10.4. Fundamentals
  - 10.5. Launching only on the local node
  - 10.6. Launching with SSH
  - 10.7. Launching with Slurm
  - 10.8. Launching with LSF
  - 10.9. Launching with PBS / Torque
  - 10.10. Launching with Grid Engine
  - 10.11. Unusual jobs
  - 10.12. Troubleshooting
- 11. Notifications
- 12. Session directory
  - 12.1. Directory location
  - 12.2. Directory name
  - 12.3. Tools
- 13. Developer’s guide
  - 13.1. Prerequisites
  - 13.2. GitHub, Git, and related topics
  - 13.3. Manually installing the GNU Autootools
  - 13.4. Installing and running Sphinx (building the PRRTE docs)
  - 13.5. ReStructured Text for those who know Markdown
- 14. Contributing to PRRTE
  - 14.1. Open source contributions
- 15. License
- 16. PRRTE manual pages
  - 16.1. Commands (section 1)
  - 16.2. Config file manual pages (section 5)
- 17. Software Version Numbers
- 18. News
  - 18.1. PRRTE v4.x series
  - 18.2. PRRTE v3.x series
  - 18.3. PRRTE v2.x series
  - 18.4. PRRTE v1.x series