Skip to content
Permalink
main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

ompi/README.md

Go to file
 
 
Cannot retrieve contributors at this time
Open MPI Official documentation Building the documentation locally
31 lines (24 sloc) 1.28 KB
Raw Blame
Open in GitHub Desktop

Open MPI

The Open MPI Project is an open source implementation of the Message Passing Interface (MPI) specification that is developed and maintained by a consortium of academic, research, and industry partners. Open MPI is therefore able to combine the expertise, technologies, and resources from all across the High Performance Computing community in order to build the best MPI library available. Open MPI offers advantages for system and software vendors, application developers and computer science researchers.

Official documentation

The Open MPI documentation can be viewed in the following ways:

  1. Online at https://docs.open-mpi.org/
  2. In self-contained (i.e., suitable for local viewing, without an internet connection) in official distribution tarballs under docs/_build/html/index.html.

Building the documentation locally

The source code for Open MPI's docs can be found in the Open MPI Git repository under the docs folder.

Developers who clone the Open MPI Git repository will not have the HTML documentation and man pages by default; it must be built. Instructions for how to build the Open MPI documentation can be found here: https://docs.open-mpi.org/en/main/developers/prerequisites.html#sphinx.