Skip to content

Commit e7a688a

Browse files
committed
Update Spack installation instructions
1 parent 8a5fb8a commit e7a688a

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

docs/source/usersguide/install.rst

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ other information use:
105105
106106
.. note::
107107

108-
It should be noted that by default OpenMC builds with ``-O2 -g`` flags which
109-
are equivalent to a CMake build type of `RelwithDebInfo`. In addition, MPI
110-
is OFF while OpenMP is ON.
108+
It should be noted that by default OpenMC is built with
109+
`-DCMAKE_BUILD_TYPE=RelwithDebInfo`. In addition, MPI is OFF while OpenMP is
110+
ON.
111111

112112
It is recommended to install OpenMC with the Python API. Information about this
113113
Spack recipe can be found with the following command:
@@ -133,17 +133,18 @@ following command:
133133
configured defaults unless otherwise specfied in the specification on the
134134
command line. In the above example, assuming the default options weren't
135135
changed in Spack's package configuration, py-openmc will link against a
136-
non-optimized non-MPI openmc. Even if an optimized openmc was built
137-
separately, it will rebuild openmc with optimization OFF. Thus, if you are
138-
trying to link against dependencies that were configured different than
139-
defaults, ``^openmc[variants]`` will have to be present in the command.
136+
non-MPI non-release build of openmc. Even if a release build of openmc was
137+
built separately, it will rebuild openmc with the default build type. Thus,
138+
if you are trying to link against dependencies that were configured
139+
different than defaults, ``^openmc[variants]`` will have to be present in
140+
the command.
140141

141-
For a more performant build of OpenMC with optimization turned ON and MPI
142-
provided by OpenMPI, the following command can be used:
142+
For a release build of OpenMC with MPI support on (provided by OpenMPI), the
143+
following command can be used:
143144

144145
.. code-block:: sh
145146
146-
spack install py-openmc+mpi ^openmc+optimize ^openmpi
147+
spack install py-openmc +mpi ^openmpi ^openmc build_type=Release
147148
148149
.. note::
149150

@@ -163,7 +164,7 @@ This can be observed using Spack's ``spec`` tool:
163164

164165
.. code-block::
165166
166-
spack spec py-openmc+mpi ^openmc+optimize
167+
spack spec py-openmc +mpi ^openmc build_type=Release
167168
168169
Once installed, environment/lmod modules can be generated or Spack's ``load``
169170
feature can be used to access the installed packages.
@@ -526,13 +527,7 @@ distribution/repository, run:
526527
pip will first check that all :ref:`required third-party packages
527528
<usersguide_python_prereqs>` have been installed, and if they are not present,
528529
they will be installed by downloading the appropriate packages from the Python
529-
Package Index (`PyPI <https://pypi.org/>`_). However, do note that since pip
530-
runs the ``setup.py`` script which requires NumPy, you will have to first
531-
install NumPy:
532-
533-
.. code-block:: sh
534-
535-
pip install numpy
530+
Package Index (`PyPI <https://pypi.org/>`_).
536531

537532
Installing in "Development" Mode
538533
--------------------------------

0 commit comments

Comments
 (0)