diff --git a/_images/math/66981fa3920210c6ad8dbe5e968783d5dd7520c3.png b/_images/math/66981fa3920210c6ad8dbe5e968783d5dd7520c3.png new file mode 100644 index 0000000000..2d943287c0 Binary files /dev/null and b/_images/math/66981fa3920210c6ad8dbe5e968783d5dd7520c3.png differ diff --git a/_sources/developers.txt b/_sources/developers.txt index 4f4713aaef..685507e796 100644 --- a/_sources/developers.txt +++ b/_sources/developers.txt @@ -9,6 +9,7 @@ Active development of the OpenMC Monte Carlo code is currently led by: * `Paul Romano`_ * `Bryan Herman`_ * `Nick Horelik`_ +* `Adam Nelson`_ Advisors to the project include: @@ -19,6 +20,7 @@ Advisors to the project include: .. _Paul Romano: mailto:paul.k.romano@gmail.com .. _Bryan Herman: mailto:bherman@mit.edu .. _Nick Horelik: mailto:nhorelik@mit.edu +.. _Adam Nelson: mailto:nelsonag@umich.edu .. _Benoit Forget: mailto:bforget@mit.edu .. _Kord Smith: mailto:kord@mit.edu .. _Andrew Siegel: mailto:siegela@mcs.anl.gov diff --git a/_sources/quickinstall.txt b/_sources/quickinstall.txt index 58bdfaf404..653ac3d863 100644 --- a/_sources/quickinstall.txt +++ b/_sources/quickinstall.txt @@ -8,67 +8,47 @@ This quick install guide outlines the basic steps needed to install OpenMC on your computer. For more detailed instructions on configuring and installing OpenMC, see :ref:`usersguide_install` in the User's Manual. -------------- -Prerequisites -------------- +-------------------------------- +Installing on Ubuntu through PPA +-------------------------------- -In order to compile and run OpenMC, a number of prerequisite software packages -and libraries may be needed. These include: +For users with Ubuntu 11.10 or later, a binary package for OpenMC is available +through a `Personal Package Archive`_ (PPA) and can be installed through the `APT +package manager`_. Simply enter the following commands into the terminal: -- A Fortran compiler such as gfortran_ -- git_ version control software for obtaining source code (*optional*) -- An MPI implementation for parallel runs (*optional*) -- HDF5_ Library for portable binary output format (*optional*) -- PETSc_ for CMFD acceleration (*optional*) +.. code-block:: sh -.. _gfortran: http://gcc.gnu.org/wiki/GFortran -.. _git: http://git-scm.com + sudo apt-add-repository ppa:paulromano/staging + sudo apt-get update + sudo apt-get install openmc + +Currently, the binary package does not allow for parallel simulations, HDF5_, or +CMFD acceleration through PETSc_. Users who need such capabilities should build +OpenMC from source as is described in :ref:`usersguide_install`. + +.. _Personal Package Archive: https://launchpad.net/~paulromano/+archive/staging +.. _APT package manager: https://help.ubuntu.com/community/AptGet/Howto .. _HDF5: http://www.hdfgroup.org/HDF5/ .. _PETSc: http://www.mcs.anl.gov/petsc/ --------------------- -Obtaining the Source --------------------- +------------------------------------------- +Installing from Source on Linux or Mac OS X +------------------------------------------- -All OpenMC source code is hosted on GitHub_. The latest version of the OpenMC -source code can be downloaded from GitHub with the following command:: +All OpenMC source code is hosted on GitHub_. If you have git_ and the gfortran_ +compiler installed, you can download and install OpenMC be entering the +following commands in a terminal: + +.. code-block:: sh git clone git@github.com:mit-crpg/openmc.git + cd openmc/src + make + sudo make install -If you don't have git installed, you can download the source as a zip or tar -file directly from GitHub. +This will build an executable named ``openmc`` and install it (by default in +/usr/local/bin). .. _GitHub: https://github.com/mit-crpg/openmc - -------------------------------- -Compiling on Linux and Mac OS X -------------------------------- - -To compile OpenMC on Linux or Max OS X, run the following commands from within -the root directory of the source code: - -.. code-block:: sh - - cd src - make - -This will build an executable named ``openmc``. - --------------------- -Compiling on Windows --------------------- - -To compile OpenMC on a Windows operating system, you will need to first install -Cygwin_, a Linux-like environment for Windows. When configuring Cygwin, make -sure you install both the gfortran compiler as well as git. Once you have -obtained the source code, run the following commands from within the source code -root directory: - -.. code-block:: sh - - cd src - make - -This will build an executable named ``openmc``. - -.. _Cygwin: http://www.cygwin.com/ +.. _git: http://git-scm.com +.. _gfortran: http://gcc.gnu.org/wiki/GFortran diff --git a/_sources/releasenotes/index.txt b/_sources/releasenotes/index.txt index e00b199f82..1fb7c0e15c 100644 --- a/_sources/releasenotes/index.txt +++ b/_sources/releasenotes/index.txt @@ -10,6 +10,7 @@ bugs fixed, and known issues for each successive release. .. toctree:: :maxdepth: 1 + notes_0.5.1 notes_0.5.0 notes_0.4.4 notes_0.4.3 diff --git a/_sources/releasenotes/notes_0.5.1.txt b/_sources/releasenotes/notes_0.5.1.txt new file mode 100644 index 0000000000..ea61e65da1 --- /dev/null +++ b/_sources/releasenotes/notes_0.5.1.txt @@ -0,0 +1,38 @@ +.. _notes_0.5.1: + +============================== +Release Notes for OpenMC 0.5.1 +============================== + +.. note:: + These release notes are for an upcoming release of OpenMC and are still + subject to change. + +------------------- +System Requirements +------------------- + +There are no special requirements for running the OpenMC code. As of this +release, OpenMC has been tested on a variety of Linux distributions, Mac OS X, +and Microsoft Windows 7. Memory requirements will vary depending on the size of +the problem at hand (mostly on the number of nuclides in the problem). + +------------ +New Features +------------ + +- Proper install capability with 'make install'. +- Lattices can now be 2 or 3 dimensions. +- New scatter-PN score type. +- New kappa-fission score type. +- Ability to tally any reaction by specifying MT. + +--------- +Bug Fixes +--------- + +- 63bfd2_: Fix tracklength tallies with cell filter and universes. +- 88daf7_: Fix analog tallies with survival biasing. + +.. _63bfd2: https://github.com/mit-crpg/openmc/commit/63bfd2 +.. _88daf7: https://github.com/mit-crpg/openmc/commit/88daf7 diff --git a/_sources/usersguide/input.txt b/_sources/usersguide/input.txt index 1e25ab4d5e..e2df231fb4 100644 --- a/_sources/usersguide/input.txt +++ b/_sources/usersguide/input.txt @@ -836,6 +836,14 @@ The following responses can be tallied. :nu-fission: Total production of neutrons due to fission + + :kappa-fission: + The recoverable energy production rate due to fission. The recoverable + energy is defined as the fission product kinetic energy, prompt and delayed neutron + kinetic energies, prompt and delayed :math:`\gamma`-ray total energies, + and the total energy released by the delayed :math:`\beta` particles. The + neutrino energy does not contribute to this response. The prompt and delayed + :math:`\gamma`-rays are assumed to deposit their energy locally. :events: Number of scoring events diff --git a/_sources/usersguide/install.txt b/_sources/usersguide/install.txt index 971c3bb015..b701fc3da2 100644 --- a/_sources/usersguide/install.txt +++ b/_sources/usersguide/install.txt @@ -4,38 +4,82 @@ Installation and Configuration ============================== -------------- +----------------------------- +Installing on Ubuntu with PPA +----------------------------- + +For users with Ubuntu 11.10 or later, a binary package for OpenMC is available +through a Personal Package Archive (PPA) and can be installed through the APT +package manager. First, add the following PPA to the repository sources: + +.. code-block:: sh + + sudo apt-add-repository ppa:paulromano/staging + +Next, resynchronize the package index files: + +.. code-block:: sh + + sudo apt-get update + +Now OpenMC should be recognized within the repository and can be installed: + +.. code-block:: sh + + sudo apt-get install openmc + +-------------------- +Building from Source +-------------------- + Prerequisites ------------- -In order to compile OpenMC, you will need to have a Fortran compiler installed -on your machine. Since a number of Fortran 2003/2008 features are used in the -code, it is recommended that you use the latest version of whatever compiler you -choose. For gfortran_, it is recommended that you use version 4.5.0 or above. +.. admonition:: Required -If you are using Debian or a Debian derivative such as Ubuntu, you can install -the gfortran compiler using the following command:: + * A Fortran compiler such as gfortran_ - sudo apt-get install gfortran + In order to compile OpenMC, you will need to have a Fortran compiler + installed on your machine. Since a number of Fortran 2003/2008 features + are used in the code, it is recommended that you use the latest version of + whatever compiler you choose. For gfortran_, it is necessary to use + version 4.6.0 or above. -To compile with support for parallel runs on a distributed-memory architecture, -you will need to have a valid implementation of MPI installed on your -machine. The code has been tested and is known to work with the latest versions -of both OpenMPI_ and MPICH2_. Note that if using OpenMPI, make sure that ---with-mpi-f90-size is not set to medium or large since this may prevent MPI -calls from completing successfully in OpenMC. OpenMPI and/or MPICH2 can be -installed on Debian derivatives with:: + If you are using Debian or a Debian derivative such as Ubuntu, you can + install the gfortran compiler using the following command:: - sudo apt-get install mpich2 - sudo apt-get install openmpi-bin + sudo apt-get install gfortran -To compile with support for HDF5_ output (highly recommended), you will need to -have HDF5 installed on your computer. The installed version will need to have -been compiled with the same compiler you intend to compile OpenMC with. +.. admonition:: Optional -To enable CMFD acceleration, you will need to have PETSc_ installed on your -computer. The installed version will need to have been compiled with the same -compiler you intend to compile OpenMC with. + * An MPI implementation for distributed-memory parallel runs + + To compile with support for parallel runs on a distributed-memory + architecture, you will need to have a valid implementation of MPI + installed on your machine. The code has been tested and is known to work + with the latest versions of both OpenMPI_ and MPICH2_. Note that if using + OpenMPI, make sure that --with-mpi-f90-size is not set to medium or large + since this may prevent MPI calls from completing successfully in + OpenMC. OpenMPI and/or MPICH2 can be installed on Debian derivatives + with:: + + sudo apt-get install mpich2 + sudo apt-get install openmpi-bin + + * HDF5_ Library for portable binary output format + + To compile with support for HDF5_ output (highly recommended), you will + need to have HDF5 installed on your computer. The installed version will + need to have been compiled with the same compiler you intend to compile + OpenMC with. + + * PETSc_ for CMFD acceleration + + To enable CMFD acceleration, you will need to have PETSc_ installed on + your computer. The installed version will need to have been compiled with + the same compiler you intend to compile OpenMC with. + + * git_ version control software for obtaining source code .. _gfortran: http://gcc.gnu.org/wiki/GFortran .. _OpenMPI: http://www.open-mpi.org @@ -43,7 +87,6 @@ compiler you intend to compile OpenMC with. .. _HDF5: http://www.hdfgroup.org/HDF5/ .. _PETSc: http://www.mcs.anl.gov/petsc/ --------------------- Obtaining the Source -------------------- @@ -63,7 +106,6 @@ repository:: .. _git: http://git-scm.com .. _ssh: http://en.wikipedia.org/wiki/Secure_Shell -------------------- Build Configuration ------------------- @@ -108,7 +150,6 @@ Makefile, you can enter the following from a terminal:: make DEBUG=yes -------------------------------- Compiling on Linux and Mac OS X ------------------------------- @@ -119,15 +160,16 @@ the root directory of the source code: cd src make + sudo make install -This will build an executable named ``openmc``. +This will build an executable named ``openmc`` and install it (by default in +/usr/local/bin). --------------------- Compiling on Windows -------------------- Using Cygwin ------------- +++++++++++++ One option for compiling OpenMC on a Windows operating system is to use Cygwin_, a Linux-like environment for Windows. You will need to first `install @@ -165,7 +207,7 @@ This will build an executable named ``openmc``. .. _install Cygwin: http://cygwin.com/setup.exe Using MinGW ------------ ++++++++++++ An alternate option for installing OpenMC on Windows is using MinGW_, which stands for Minimalist GNU for Windows. An executable for installing the MinGW diff --git a/developers.html b/developers.html index b748a4c00c..644855a062 100644 --- a/developers.html +++ b/developers.html @@ -55,6 +55,7 @@
  • Paul Romano
  • Bryan Herman
  • Nick Horelik
    • +
  • Adam Nelson

    • Advisors to the project include: