diff --git a/doc/CHANGELOG.rst b/doc/CHANGELOG.rst index 84e27cb1b1..5f4b9ac7ab 100644 --- a/doc/CHANGELOG.rst +++ b/doc/CHANGELOG.rst @@ -31,6 +31,7 @@ Next version * Patch to compile with gcc-13 (#882) * Tweak conda environment for Windows build to avoid conflicting gtest headers (#888) * Restrict cython version for MOAB (#893) + * Various documentation updates (#869) v3.2.2 ==================== diff --git a/doc/index.rst b/doc/index.rst index 623a5c1ad8..8607cb3c27 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -11,20 +11,31 @@ DAGMC: Direct Accelerated Geometry Monte Carlo | -.. image:: https://circleci.com/gh/svalinn/DAGMC.svg?style=shield - :target: https://circleci.com/gh/svalinn/DAGMC - :height: 20 - :width: 90 - :align: left +.. image:: https://github.com/svalinn/DAGMC/actions/workflows/linux_build_test.yml/badge.svg?branch=develop + :target: https://github.com/svalinn/DAGMC/actions/workflows/linux_build_test.yml + +.. image:: https://github.com/svalinn/DAGMC/actions/workflows/mac_build_test.yml/badge.svg?branch=develop + :target: https://github.com/svalinn/DAGMC/actions/workflows/mac_build_test.yml + +.. image:: https://github.com/svalinn/DAGMC/actions/workflows/windows_build_test.yml/badge.svg?branch=develop + :target: https://github.com/svalinn/DAGMC/actions/workflows/windows_build_test.yml + +.. image:: https://github.com/svalinn/DAGMC/actions/workflows/docker_publish.yml/badge.svg?branch=develop + :target: https://github.com/svalinn/DAGMC/actions/workflows/docker_publish.yml + +.. image:: https://anaconda.org/conda-forge/dagmc/badges/version.svg + :target: https://anaconda.org/conda-forge/dagmc | Direct Accelerated Geometry Monte Carlo (DAGMC) is a software package that allows users to perform Monte Carlo radiation transport directly on CAD models. -DAGMC has been integrated into a variety of Monte Carlo radiation codes -including MCNP5_, MCNP6_, Geant4_, FLUKA_, Tripoli4_, OpenMC_, and Shift_. There are also -efforts planned to integrate DAGMC into other codes such as Serpent2_, Phits_, and FRENSIE_. +DAGMC has been integrated into a variety of Monte Carlo radiation codes. +Implementations are actively maintained from OpenMC_ and MCNP6_. Implementations +are occasionally updated for Geant4_ and FLUKA_. The last implementation for +Shift_ is still used internally at ORNL. An implementation is available for +MCNP5_. DAGMC was demonstrated in Tripoli4_ in 2010, but not maintained. DAGMC currently relies on using the commercial solid modeling software Cubit_ (or its `government-use counterpart `_ available from @@ -48,15 +59,12 @@ materials and other geometry-related information. gallery/gallery .. _CNERG: https://cnerg.github.io -.. _MOAB: https://press3.mcs.anl.gov/sigma/moab-library +.. _MOAB: https://sigma.mcs.anl.gov/moab-library/ .. _Cubit: https://coreform.com/products/coreform-cubit/ -.. _MCNP5: https://laws.lanl.gov/vhosts/mcnp.lanl.gov/mcnp5.shtml +.. _MCNP5: https://mcnp.lanl.gov .. _MCNP6: https://mcnp.lanl.gov .. _Geant4: https://geant4.cern.ch .. _FLUKA: http://www.fluka.org/fluka.php .. _Tripoli4: https://rsicc.ornl.gov/codes/ccc/ccc8/ccc-806.html .. _Shift: https://meitner.ornl.gov/doe-codes/shift -.. _Serpent2: http://montecarlo.vtt.fi .. _OpenMC: https://docs.openmc.org/en/latest/index.html -.. _Phits: https://phits.jaea.go.jp -.. _FRENSIE: https://github.com/FRENSIE/FRENSIE diff --git a/doc/install/dependencies.rst b/doc/install/dependencies.rst index 7dc70f27ec..91cd42e912 100644 --- a/doc/install/dependencies.rst +++ b/doc/install/dependencies.rst @@ -79,7 +79,7 @@ Redhat linux users can do likewise with: MOAB installation ~~~~~~~~~~~~~~~~~ -As of DAGMC version 3.1, MOAB version 5.1.0 or higher is required. The following +As of DAGMC version 3.2, a MOAB version between 5.1.0 and 5.3.0 is required. The following commands can be used to download MOAB from its `source repository `_ and set it up for building. :: @@ -87,37 +87,24 @@ set it up for building. $ cd $HOME/dagmc_bld $ mkdir -p MOAB/bld $ cd MOAB - $ git clone https://bitbucket.org/fathomteam/moab - $ cd moab - $ git checkout Version5.1.0 - $ autoreconf -fi - $ cd .. - $ ln -s moab src - -If you have followed the source install route, then the following commands -should be used to build MOAB. + $ git clone --depth 1 -b 5.3.0 https://bitbucket.org/fathomteam/moab + +To build moab using the default packages: :: $ cd bld - $ ../src/configure --enable-optimize \ - --enable-shared \ - --disable-debug \ - --with-hdf5=$HOME/dagmc_bld/HDF5 \ - --prefix=$HOME/dagmc_bld/MOAB + $ cmake ../moab -DENABLE_HDF5=ON -DHDF5_ROOT=${hdf5_install_dir} \ + -DCMAKE_BUILD_TYPE=Release \ + -DENABLE_PYMOAB=ON \ + -DENABLE_BLASLAPACK=OFF \ + -DENABLE_FORTRAN=OFF \ + -DCMAKE_INSTALL_PREFIX=$HOME/dagmc_bld/MOAB \ + -DBUILD_SHARED_LIBS=ON \ + -DCMAKE_INSTALL_RPATH=${hdf5_install_dir}/lib:${moab_install_dir}/lib $ make $ make check $ make install -If you have followed the package manager install route, then the following -configure command should be used to build MOAB. -:: - - $ ../src/configure --enable-optimize \ - --enable-shared \ - --disable-debug \ - --with-hdf5=/usr/lib/x86_64-linux-gnu/hdf5/serial \ - --prefix=$HOME/dagmc_bld/MOAB - Making sure the dependencies were installed correctly ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -137,7 +124,7 @@ successfully. $ which h5ls $ which mbconvert -If you have installed the dependencies corretly, you are now ready to +If you have installed the dependencies correctly, you are now ready to `install DAGMC `_. .. _HDF5: http://www.hdfgroup.org/HDF5 diff --git a/doc/install/index.rst b/doc/install/index.rst index e07678d792..a011811173 100644 --- a/doc/install/index.rst +++ b/doc/install/index.rst @@ -1,17 +1,23 @@ DAGMC installation overview =========================== -This document describes the DAGMC installation process. Before you begin, you -should know that the following will be required: +This document describes the DAGMC installation process. + +If you plan to use OpenMC_, you can follow `their installation +instructions `_ with +DAGMC built-in. + +Otherwise, before you begin, you should know that the following will be +required: 1. A basic understanding of Unix/Linux shell commands and how to navigate the shell, for installing dependencies and DAGMC enabled codes -2. MCNP5_ or MCNP6_ source code, if you intend to install DAG-MCNP5 or - DAG-MCNP6 +2. MCNP6_ source code, if you intend to install DAG-MCNP6 (or MCNP5_ source + code for DAG-MCNP5) 3. FLUKA_, if you intend to install FluDAG 4. Coreform Cubit_ for the creation of geometry -Once you have the basic pre-requisite peices in place you can proceed to the +Once you have the basic pre-requisite pieces in place you can proceed to the DAGMC installation. There are three main steps in the DAGMC installation: .. toctree:: @@ -26,7 +32,9 @@ DAGMC-based radiation transport calculations. The `User's Guide <../usersguide/index.html>`_ will guide you through the workflow options available to you. -.. _MCNP5: https://laws.lanl.gov/vhosts/mcnp.lanl.gov/mcnp5.shtml +.. _MCNP5: https://mcnp.lanl.gov .. _MCNP6: https://mcnp.lanl.gov .. _FLUKA: http://www.fluka.org/fluka.php .. _Cubit: https://coreform.com/products/coreform-cubit/ +.. _OpenMC_install: https://docs.openmc.org/en/stable/quickinstall.html +.. _OpenMC: https://docs.openmc.org/en/latest/index.html