crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 06:05:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Several small documentation updates (#2558)

Browse source
This commit is contained in:
Paul Romano 2023-06-13 06:19:10 -05:00 • committed by GitHub
parent 6693ff3229
commit 98c4eb2a2c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 33 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/source/usersguide/basics.rst
View file

@ -83,12 +83,12 @@ Creating Input Files
.. currentmodule:: openmc
The most rudimentary option for creating input files is to simply write them
from scratch using the :ref:`XML format specifications
<io_file_formats_input>`. This approach will feel familiar to users of other
Monte Carlo codes such as MCNP and Serpent, with the added bonus that the XML
formats feel much more "readable". Alternatively, input files can be generated
using OpenMC's :ref:`Python API <pythonapi>`, which is introduced in the
following section.
from scratch using the :ref:`XML format specifications <io_file_formats_input>`.
This approach will feel familiar to users of other Monte Carlo codes such as
MCNP and Serpent, with the added bonus that the XML formats feel much more
"readable". However, it is strongly recommended to generate input files using
OpenMC's :ref:`Python API <pythonapi>`, which is introduced in the following
section.
----------
Python API
@ -178,14 +178,3 @@ energy electronvolt eV
time second s
======= ============ ======
------------------------------------
ERSN-OpenMC Graphical User Interface
------------------------------------
A third-party Java-based user-friendly graphical user interface for creating XML
input files called ERSN-OpenMC_ is developed and maintained by members of the
Radiation and Nuclear Systems Group at the Faculty of Sciences Tetouan, Morocco.
The GUI also allows one to automatically download prerequisites for installing and
running OpenMC.
.. _ERSN-OpenMC: https://github.com/EL-Bakkali-Jaafar/ERSN-OpenMC

20
docs/source/usersguide/install.rst
View file

@ -488,13 +488,13 @@ OpenMC locally by specifying an install prefix when running cmake:
The ``CMAKE_INSTALL_PREFIX`` variable can be changed to any path for which you
have write-access.
Compiling on Windows 10
-----------------------
Compiling on Windows
--------------------
Recent versions of Windows 10 include a subsystem for Linux that allows one to
run Bash within Ubuntu running in Windows. First, follow the installation guide
`here <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ to get Bash
on Ubuntu on Windows setup. Once you are within bash, obtain the necessary
Recent versions of Windows include a subsystem for Linux that allows one to run
Bash within Ubuntu running in Windows. First, follow the installation guide
`here <https://learn.microsoft.com/en-us/windows/wsl/install>`_ to get Bash on
Ubuntu on Windows set up. Once you are within bash, obtain the necessary
:ref:`prerequisites <prerequisites>` via ``apt``. Finally, follow the
:ref:`instructions for compiling on linux <compile_linux>`.
@ -522,7 +522,7 @@ distribution/repository, run:
.. code-block:: sh
pip install .
python -m pip install .
pip will first check that all :ref:`required third-party packages
<usersguide_python_prereqs>` have been installed, and if they are not present,
@ -608,15 +608,15 @@ for OpenMC. Thus, the install process would proceed as follows:
make install
cd ..
MPICC=<path to mpicc> pip install mpi4py
HDF5_DIR=<path to HDF5> pip install --no-binary=h5py h5py
MPICC=<path to mpicc> python -m pip install mpi4py
HDF5_DIR=<path to HDF5> python -m pip install --no-binary=h5py h5py
If you are using parallel HDF5, you'll also need to make sure the right MPI
wrapper is used when installing h5py:
.. code-block:: sh
CC=<path to mpicc> HDF5_MPI=ON HDF5_DIR=<path to HDF5> pip install --no-binary=h5py h5py
CC=<path to mpicc> HDF5_MPI=ON HDF5_DIR=<path to HDF5> python -m pip install --no-binary=h5py h5py
.. _Conda: https://conda.io/en/latest/
.. _pip: https://pip.pypa.io/en/stable/