From 1ee5e56c6ab0157caa22d5d1fe78454aace649db Mon Sep 17 00:00:00 2001 From: guillaume Date: Sat, 24 Mar 2018 15:56:59 -0400 Subject: [PATCH 1/4] added install information to documentation --- docs/source/usersguide/install.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 24bcc7164..5171eb4ec 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -148,8 +148,8 @@ Prerequisites .. important:: If you are building HDF5 version 1.8.x or earlier, you must include - ``--enable-fortran2003`` when configuring HDF5 or else OpenMC will not - be able to compile. + ``--enable-fortran2003`` as well when configuring HDF5 or else OpenMC + will not be able to compile. .. admonition:: Optional :class: note @@ -416,7 +416,8 @@ Prerequisites The Python API works with Python 3.4+. In addition to Python itself, the API relies on a number of third-party packages. All prerequisites can be installed using Conda_ (recommended), pip_, or through the package manager in most Linux -distributions. +distributions. To run simulations in parallel using MPI, it is recommended to +build mpi4py, hdf5, h5py from source, in that order, using the same compilers. .. admonition:: Required :class: error @@ -455,7 +456,7 @@ distributions. `mpi4py `_ mpi4py provides Python bindings to MPI for running distributed-memory parallel runs. This package is needed if you plan on running depletion - simulations in parallel using MPI. + simulations. `Cython `_ Cython is used for resonance reconstruction for ENDF data converted to From 627c10046789ff753eaa4f3000145597c29516bd Mon Sep 17 00:00:00 2001 From: guillaume Date: Sat, 24 Mar 2018 16:04:57 -0400 Subject: [PATCH 2/4] one more detail on installation --- docs/source/usersguide/install.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 5171eb4ec..6b24c64dd 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -417,7 +417,8 @@ The Python API works with Python 3.4+. In addition to Python itself, the API relies on a number of third-party packages. All prerequisites can be installed using Conda_ (recommended), pip_, or through the package manager in most Linux distributions. To run simulations in parallel using MPI, it is recommended to -build mpi4py, hdf5, h5py from source, in that order, using the same compilers. +build mpi4py, hdf5, h5py from source, in that order, using the same compilers +as for openmc. .. admonition:: Required :class: error From 0d6cb83f2692a89b6262c93885a43814086fa1fb Mon Sep 17 00:00:00 2001 From: guillaume Date: Mon, 2 Apr 2018 13:51:46 -0400 Subject: [PATCH 3/4] in doc : fixed naming conventions, mistake on depletion requirements --- docs/source/usersguide/install.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 6b24c64dd..34c8395e0 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -417,8 +417,8 @@ The Python API works with Python 3.4+. In addition to Python itself, the API relies on a number of third-party packages. All prerequisites can be installed using Conda_ (recommended), pip_, or through the package manager in most Linux distributions. To run simulations in parallel using MPI, it is recommended to -build mpi4py, hdf5, h5py from source, in that order, using the same compilers -as for openmc. +build mpi4py, HDF5, h5py from source, in that order, using the same compilers +as for openMC. .. admonition:: Required :class: error @@ -457,7 +457,7 @@ as for openmc. `mpi4py `_ mpi4py provides Python bindings to MPI for running distributed-memory parallel runs. This package is needed if you plan on running depletion - simulations. + simulations in parallel using MPI. `Cython `_ Cython is used for resonance reconstruction for ENDF data converted to From 8c14c8230fc6c2f000c8c2ddcf529a3223b30812 Mon Sep 17 00:00:00 2001 From: guillaume Date: Mon, 2 Apr 2018 14:02:55 -0400 Subject: [PATCH 4/4] in doc : naming convention --- docs/source/usersguide/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 34c8395e0..b0618818e 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -418,7 +418,7 @@ relies on a number of third-party packages. All prerequisites can be installed using Conda_ (recommended), pip_, or through the package manager in most Linux distributions. To run simulations in parallel using MPI, it is recommended to build mpi4py, HDF5, h5py from source, in that order, using the same compilers -as for openMC. +as for OpenMC. .. admonition:: Required :class: error