Skip to content

Commit f073b9a

Browse files
committed
docs: a bunch of random updates
- Add a section about installing binary packages to the quickstart install page - Remove the MacOS FAQ page; fold relevant content into other parts of the docs. - Remove the redundant OPA networking page; its content was already included in the OFI networking page. Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
1 parent ba274c5 commit f073b9a

File tree

6 files changed

+35
-155
lines changed

6 files changed

+35
-155
lines changed

docs/faq/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,5 @@ that they are worth categorizing in an official way.
2424
large-clusters
2525

2626
ompio
27-
macos
2827

2928
general-tuning

docs/faq/macos.rst

Lines changed: 0 additions & 104 deletions
This file was deleted.

docs/installing-open-mpi/quickstart.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,40 @@ probably work in many environments.
1919
Developer's Guide </developers/index>` before attempting to build Open
2020
MPI. Really.
2121

22+
Binary packages
23+
---------------
24+
25+
Although the Open MPI community itself does not distribute binary
26+
packages for Open MPI, many downstream packagers do.
27+
28+
For example, many Linux distributions include Open MPI packages
29+
|mdash| even if they are not installed by default. You should consult
30+
the documentation and/or package list for your Linux distribution to
31+
see if you can use its built-in package system to install Open MPI.
32+
33+
The MacOS package managers `Homebrew <https://brew.sh/>`_ and
34+
`MacPorts <https://macports.org/>`_ both offer binary Open MPI
35+
packages:
36+
37+
.. code-block:: sh
38+
39+
# For Homebrew
40+
shell$ brew install openmpi
41+
42+
# For MacPorts
43+
shell$ port install openmpi
44+
45+
.. important:: Binary packages may or may not include support for
46+
features that are required on your platform (e.g., a
47+
specific networking stack). Or the binary packages
48+
available to you may be older / out of date. As such,
49+
it may be better to build and install Open MPI from a
50+
source tarball available from `the main Open MPI web
51+
site <https://www.open-mpi.org/>`_.
52+
53+
Building from source
54+
--------------------
55+
2256
Open MPI uses a traditional ``configure`` script paired with ``make``
2357
to build. Typical installs can be of the pattern:
2458

docs/networking/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ build support for that library).
2222
ofi
2323
tcp
2424
shared-memory
25-
opa
2625
ib-and-roce
2726
iwarp
2827
cuda

docs/networking/ofi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ For more information refer to the `Libfabric web site
7878

7979
/////////////////////////////////////////////////////////////////////////
8080

81-
Ompi-Path: How can the multi-rail settings be adjusted if multiple HFI (Host Fabric Interface) cards are installed on the system?
81+
Omni-Path: How can the multi-rail settings be adjusted if multiple HFI (Host Fabric Interface) cards are installed on the system?
8282
---------------------------------------------------------------------------------------------------------------------------------
8383

8484
Multi-Rail feature allows a process to use multiple HFIs to transfer a message

docs/networking/opa.rst

Lines changed: 0 additions & 48 deletions
This file was deleted.

0 commit comments

Comments
 (0)