Merge branch 'develop' into photon-documentation

docs/source/devguide/docker.rst

@@ -0,0 +1,57 @@
+.. _devguide_docker:
+
+======================
+Deployment with Docker
+======================
+
+OpenMC can be easily deployed using `Docker <https://www.docker.com/>`_ on any
+Windows, Mac or Linux system. With Docker running, execute the following
+command in the shell to build a `Docker image`_ called ``debian/openmc:latest``:
+
+.. code-block:: sh
+
+    docker build -t debian/openmc:latest https://github.com/openmc-dev/openmc.git#develop
+
+.. note:: This may take 5 -- 10 minutes to run to completion.
+
+This command will execute the instructions in OpenMC's ``Dockerfile`` to
+build a Docker image with OpenMC installed. The image includes OpenMC with
+MPICH and parallel HDF5 in the ``/opt/openmc`` directory, and
+`Miniconda3 <https://conda.io/miniconda.html>`_ with all of the Python
+pre-requisites (NumPy, SciPy, Pandas, etc.) installed. The
+`NJOY2016 <http://www.njoy21.io/NJOY2016/>`_ codebase is installed in
+``/opt/NJOY2016`` to support full functionality and testing of the
+``openmc.data`` Python module. The publicly available nuclear data libraries
+necessary to run OpenMC's test suite -- including NNDC and WMP cross sections
+and ENDF data --  are in the ``/opt/openmc/data directory``, and the
+corresponding :envvar:`OPENMC_CROSS_SECTIONS`,
+:envvar:`OPENMC_MULTIPOLE_LIBRARY`, and :envvar:`OPENMC_ENDF_DATA`
+environment variables are initialized.
+
+After building the Docker image, you can run the following to see the names of
+all images on your machine, including ``debian/openmc:latest``:
+
+.. code-block:: sh
+
+    docker image ls
+
+Now you can run the following to create a `Docker container`_ called
+``my_openmc`` based on the ``debian/openmc:latest`` image:
+
+.. code-block:: sh
+
+    docker run -it --name=my_openmc debian/openmc:latest
+
+This command will open an interactive shell running from within the
+Docker container where you have access to use OpenMC.
+
+.. note:: The ``docker run`` command supports many
+          `options <https://docs.docker.com/engine/reference/commandline/run/>`_
+          for spawning containers -- including `mounting volumes`_ from the
+          host filesystem -- which many users will find useful.
+
+.. _Docker image: https://docs.docker.com/engine/reference/commandline/images/
+.. _Docker container: https://www.docker.com/resources/what-container
+.. _options: https://docs.docker.com/engine/reference/commandline/run/
+.. _mounting volumes: https://docs.docker.com/storage/volumes/
+

docs/source/devguide/index.rst

@@ -18,3 +18,4 @@ other related topics.
     tests
     user-input
     docbuild
+    docker

docs/source/io_formats/fission_energy.rst

@@ -1,53 +0,0 @@
-.. _usersguide_fission_energy:
-
-==================================
-Fission Energy Release File Format
-==================================
-
-This file is a compact HDF5 representation of the ENDF MT=1, MF=458 data (see
-ENDF-102_ for details).  It gives the information needed to compute the energy
-carried away from fission reactions by each reaction product (e.g. fragment
-nuclei, neutrons) which depends on the incident neutron energy.  OpenMC is
-distributed with one of these files under
-data/fission_Q_data_endfb71.h5.  More files of this format can be created from
-ENDF files with the
-``openmc.data.write_compact_458_library`` function.  They can be read with the
-``openmc.data.FissionEnergyRelease.from_compact_hdf5`` class method.
-
-:Attributes: - **comment** (*char[]*) -- An optional text comment
-             - **component order** (*char[][]*) -- An array of strings
-               specifying the order each reaction product occurs in the data
-               arrays.  The components use the 2-3 letter abbreviations
-               specified in ENDF-102 e.g. EFR for fission fragments and ENP for
-               prompt neutrons.
-
-**/<nuclide name>/**
-    Nuclides are named by concatenating their atomic symbol and mass number. For
-    example, 'U235' or 'Pu239'.  Metastable nuclides are appended with an
-    '_m' and their metastable number.  For example, 'Am242_m1'
-
-:Datasets:
-          - **data** (*double[][][]*) -- The energy release coefficients.  The
-             first axis indexes the component type.  The second axis specifies
-             values or uncertainties.  The third axis indexes the polynomial
-             order.  If the data uses the Sher-Beck format, then the last axis
-             will have a length of one and ENDF-102 should be consulted for
-             energy dependence.  Otherwise, the data uses the Madland format
-             which is a polynomial of incident energy.
-
-             For example, if 'EFR' is given first in the **component order**
-             attribute and the data uses the Madland format, then the energy
-             released in the form of fission fragments at an incident energy
-             :math:`E` is given by
-
-             .. math::
-                \text{data}[0, 0, 0] + \text{data}[0, 0, 1] \cdot E
-                + \text{data}[0, 0, 2] \cdot E^2 + \ldots
-              
-             And its uncertainty is
-
-             .. math::
-                \text{data}[0, 1, 0] + \text{data}[0, 1, 1] \cdot E
-                + \text{data}[0, 1, 2] \cdot E^2 + \ldots
-
-.. _ENDF-102: http://www.nndc.bnl.gov/endfdocs/ENDF-102-2012.pdf

docs/source/io_formats/index.rst

@@ -34,7 +34,6 @@ Data Files
    nuclear_data
    mgxs_library
    data_wmp
-   fission_energy
 
 ------------
 Output Files

docs/source/io_formats/summary.rst

@@ -24,6 +24,8 @@ The current version of the summary file format is 6.0.
              - **n_universes** (*int*) -- Number of unique universes in the
                problem.
              - **n_lattices** (*int*) -- Number of lattices in the problem.
+             - **dagmc** (*int*) -- Indicates that a DAGMC geometry was used
+               if present.
 
 **/geometry/cells/cell <uid>/**
 

docs/source/pythonapi/data.rst

@@ -39,7 +39,6 @@ Core Functions
     openmc.data.linearize
     openmc.data.thin
     openmc.data.water_density
-    openmc.data.write_compact_458_library
     openmc.data.zam
 
 Angle-Energy Distributions

docs/source/quickinstall.rst

@@ -58,6 +58,29 @@ are no longer supported.
 .. _Personal Package Archive: https://launchpad.net/~paulromano/+archive/staging
 .. _APT package manager: https://help.ubuntu.com/community/AptGet/Howto
 
+-------------------------------------------
+Installing on Linux/Mac/Windows with Docker
+-------------------------------------------
+
+OpenMC can be easily deployed using `Docker <https://www.docker.com/>`_ on any
+Windows, Mac or Linux system. With Docker running, execute the following
+command in the shell to download and run a `Docker image`_ with the most recent release of OpenMC from `DockerHub <https://hub.docker.com/>`_ called ``openmc/openmc:v0.10.0``:
+
+.. code-block:: sh
+
+    docker run openmc/openmc:v0.10.0
+
+This will take several minutes to run depending on your internet download speed. The command will place you in an interactive shell running in a `Docker container`_ with OpenMC installed.
+
+.. note:: The ``docker run`` command supports many `options`_ for spawning
+          containers -- including `mounting volumes`_ from the host
+	  filesystem -- which many users will find useful.
+
+.. _Docker image: https://docs.docker.com/engine/reference/commandline/images/
+.. _Docker container: https://www.docker.com/resources/what-container
+.. _options: https://docs.docker.com/engine/reference/commandline/run/
+.. _mounting volumes: https://docs.docker.com/storage/volumes/
+
 ---------------------------------------
 Installing from Source on Ubuntu 15.04+
 ---------------------------------------