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

Updated documentation.

Browse source
This commit is contained in:
Paul Romano 2013-01-30 16:52:28 -05:00
parent 53cb5a11ff
commit 5e3214d22d
44 changed files with 438 additions and 207 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
_images/math/66981fa3920210c6ad8dbe5e968783d5dd7520c3.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 171 B

2
_sources/developers.txt
View file

@ -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

84
_sources/quickinstall.txt
View file

@ -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

1
_sources/releasenotes/index.txt
View file

@ -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

38
_sources/releasenotes/notes_0.5.1.txt Normal file
View file

@ -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

8
_sources/usersguide/input.txt
View file

@ -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

102
_sources/usersguide/install.txt
View file

@ -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

3
developers.html
View file

@ -55,6 +55,7 @@
<li><a class="reference external" href="mailto:paul&#46;k&#46;romano&#37;&#52;&#48;gmail&#46;com">Paul Romano</a></li>
<li><a class="reference external" href="mailto:bherman&#37;&#52;&#48;mit&#46;edu">Bryan Herman</a></li>
<li><a class="reference external" href="mailto:nhorelik&#37;&#52;&#48;mit&#46;edu">Nick Horelik</a></li>
<li><a class="reference external" href="mailto:nelsonag&#37;&#52;&#48;umich&#46;edu">Adam Nelson</a></li>
</ul>
<p>Advisors to the project include:</p>
<ul class="simple">
@ -78,7 +79,7 @@
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
devguide/index.html
View file

@ -111,7 +111,7 @@ as debugging.</p>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
devguide/statepoint.html
View file

@ -1165,7 +1165,7 @@ the i-th tally</div></blockquote>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
devguide/structures.html
View file

@ -188,7 +188,7 @@ module</a> is of type MaterialMacroXS.</p>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
devguide/styleguide.html
View file

@ -174,7 +174,7 @@ No: if ( variable==2 ) then</pre>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
devguide/workflow.html
View file

@ -101,7 +101,7 @@ of pulling a branch from your private repository into your public fork.</p>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
devguide/xml-fortran.html
View file

@ -96,7 +96,7 @@ run. You will need to be familiar with RELAX NG <a class="reference external" hr
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
genindex.html
View file

@ -110,7 +110,7 @@
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
index.html
View file

@ -89,7 +89,7 @@ feel free to contact <a class="reference external" href="mailto:paul&#46;k&#46;r
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
license.html
View file

@ -86,7 +86,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
methods/cross_sections.html
View file

@ -144,7 +144,7 @@ indexing</em> and is available as an option in Serpent (see paper by <a class="r
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
methods/eigenvalue.html
View file

@ -179,7 +179,7 @@ Convergence,&#8221; <em>Trans. Am. Nucl. Soc.</em>, <strong>98</strong>, 512 (20
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
methods/geometry.html
View file

@ -601,7 +601,7 @@ w' = w - \frac{2 ( \bar{x}u + \bar{y}v + \bar{z}w ) \bar{z} }{R^2}"/></p>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
methods/index.html
View file

@ -187,7 +187,7 @@
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
methods/introduction.html
View file

@ -180,7 +180,7 @@ and its variance is calculated.</li>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
methods/parallelization.html
View file

@ -526,7 +526,7 @@ Radiation Penetration Calculations on a Parallel Computer,&#8221;
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
methods/physics.html
View file

@ -1179,7 +1179,7 @@ book can be obtained for free from the <a class="reference external" href="http:
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
methods/random_numbers.html
View file

@ -129,7 +129,7 @@ Different Sizes and Good Lattice Structures,&#8221; <em>Math. Comput.</em>, <str
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
methods/tallies.html
View file

@ -426,7 +426,7 @@ in Statistics - Simulation and Computation, 16 (4), pp. 1123-1132 (1987).</td></
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

BIN
objects.inv
View file

Binary file not shown.

2
publications.html
View file

@ -86,7 +86,7 @@ Carlo Criticality Calculations,&#8221; <em>Nucl. Sci. Eng.</em>, <strong>170</st
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

60
quickinstall.html
View file

@ -56,49 +56,33 @@
<p>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 <a class="reference internal" href="usersguide/install.html#usersguide-install"><em>Installation and Configuration</em></a> in the User&#8217;s Manual.</p>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<p>In order to compile and run OpenMC, a number of prerequisite software packages
and libraries may be needed. These include:</p>
<ul class="simple">
<li>A Fortran compiler such as <a class="reference external" href="http://gcc.gnu.org/wiki/GFortran">gfortran</a></li>
<li><a class="reference external" href="http://git-scm.com">git</a> version control software for obtaining source code (<em>optional</em>)</li>
<li>An MPI implementation for parallel runs (<em>optional</em>)</li>
<li><a class="reference external" href="http://www.hdfgroup.org/HDF5/">HDF5</a> Library for portable binary output format (<em>optional</em>)</li>
<li><a class="reference external" href="http://www.mcs.anl.gov/petsc/">PETSc</a> for CMFD acceleration (<em>optional</em>)</li>
</ul>
</div>
<div class="section" id="obtaining-the-source">
<h2>Obtaining the Source<a class="headerlink" href="#obtaining-the-source" title="Permalink to this headline"></a></h2>
<p>All OpenMC source code is hosted on <a class="reference external" href="https://github.com/mit-crpg/openmc">GitHub</a>. The latest version of the OpenMC
source code can be downloaded from GitHub with the following command:</p>
<div class="highlight-python"><pre>git clone git@github.com:mit-crpg/openmc.git</pre>
</div>
<p>If you don&#8217;t have git installed, you can download the source as a zip or tar
file directly from GitHub.</p>
</div>
<div class="section" id="compiling-on-linux-and-mac-os-x">
<h2>Compiling on Linux and Mac OS X<a class="headerlink" href="#compiling-on-linux-and-mac-os-x" title="Permalink to this headline"></a></h2>
<p>To compile OpenMC on Linux or Max OS X, run the following commands from within
the root directory of the source code:</p>
<div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>src
make
<div class="section" id="installing-on-ubuntu-through-ppa">
<h2>Installing on Ubuntu through PPA<a class="headerlink" href="#installing-on-ubuntu-through-ppa" title="Permalink to this headline"></a></h2>
<p>For users with Ubuntu 11.10 or later, a binary package for OpenMC is available
through a <a class="reference external" href="https://launchpad.net/~paulromano/+archive/staging">Personal Package Archive</a> (PPA) and can be installed through the <a class="reference external" href="https://help.ubuntu.com/community/AptGet/Howto">APT
package manager</a>. Simply enter the following commands into the terminal:</p>
<div class="highlight-sh"><div class="highlight"><pre>sudo apt-add-repository ppa:paulromano/staging
sudo apt-get update
sudo apt-get install openmc
</pre></div>
</div>
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt>.</p>
<p>Currently, the binary package does not allow for parallel simulations, <a class="reference external" href="http://www.hdfgroup.org/HDF5/">HDF5</a>, or
CMFD acceleration through <a class="reference external" href="http://www.mcs.anl.gov/petsc/">PETSc</a>. Users who need such capabilities should build
OpenMC from source as is described in <a class="reference internal" href="usersguide/install.html#usersguide-install"><em>Installation and Configuration</em></a>.</p>
</div>
<div class="section" id="compiling-on-windows">
<h2>Compiling on Windows<a class="headerlink" href="#compiling-on-windows" title="Permalink to this headline"></a></h2>
<p>To compile OpenMC on a Windows operating system, you will need to first install
<a class="reference external" href="http://www.cygwin.com/">Cygwin</a>, 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:</p>
<div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>src
<div class="section" id="installing-from-source-on-linux-or-mac-os-x">
<h2>Installing from Source on Linux or Mac OS X<a class="headerlink" href="#installing-from-source-on-linux-or-mac-os-x" title="Permalink to this headline"></a></h2>
<p>All OpenMC source code is hosted on <a class="reference external" href="https://github.com/mit-crpg/openmc">GitHub</a>. If you have <a class="reference external" href="http://git-scm.com">git</a> and the <a class="reference external" href="http://gcc.gnu.org/wiki/GFortran">gfortran</a>
compiler installed, you can download and install OpenMC be entering the
following commands in a terminal:</p>
<div class="highlight-sh"><div class="highlight"><pre>git clone git@github.com:mit-crpg/openmc.git
<span class="nb">cd </span>openmc/src
make
sudo make install
</pre></div>
</div>
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt>.</p>
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt> and install it (by default in
/usr/local/bin).</p>
</div>
</div>
@ -118,7 +102,7 @@ make
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

9
releasenotes/index.html
View file

@ -28,7 +28,7 @@
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/theme_extras.js"></script>
<link rel="top" title="OpenMC Documentation" href="../index.html" />
<link rel="next" title="Release Notes for OpenMC 0.5.0" href="notes_0.5.0.html" />
<link rel="next" title="Release Notes for OpenMC 0.5.1" href="notes_0.5.1.html" />
<link rel="prev" title="Quick Install Guide" href="../quickinstall.html" />
</head>
<body>
@ -44,7 +44,7 @@
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="notes_0.5.0.html">Release Notes for OpenMC 0.5.0</a>&#160;&#160;»
<a href="notes_0.5.1.html">Release Notes for OpenMC 0.5.1</a>&#160;&#160;»
</p>
</div>
@ -57,6 +57,7 @@
bugs fixed, and known issues for each successive release.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="notes_0.5.1.html">Release Notes for OpenMC 0.5.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes_0.5.0.html">Release Notes for OpenMC 0.5.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes_0.4.4.html">Release Notes for OpenMC 0.4.4</a></li>
<li class="toctree-l1"><a class="reference internal" href="notes_0.4.3.html">Release Notes for OpenMC 0.4.3</a></li>
@ -76,14 +77,14 @@ bugs fixed, and known issues for each successive release.</p>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="notes_0.5.0.html">Release Notes for OpenMC 0.5.0</a>&#160;&#160;»
<a href="notes_0.5.1.html">Release Notes for OpenMC 0.5.1</a>&#160;&#160;»
</p>
</div>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
releasenotes/notes_0.4.0.html
View file

@ -101,7 +101,7 @@ can now be successfully run in OpenMC.</li>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
releasenotes/notes_0.4.1.html
View file

@ -113,7 +113,7 @@ the source bank to be of type Bank rather than of type Particle.</li>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
releasenotes/notes_0.4.2.html
View file

@ -110,7 +110,7 @@ nuclide on the material.</li>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
releasenotes/notes_0.4.3.html
View file

@ -107,7 +107,7 @@ the problem at hand (mostly on the number of nuclides in the problem).</p>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
releasenotes/notes_0.4.4.html
View file

@ -104,7 +104,7 @@ to turn them on with &lt;output&gt; tag in settings.xml file.</li>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

8
releasenotes/notes_0.5.0.html
View file

@ -30,7 +30,7 @@
<link rel="top" title="OpenMC Documentation" href="../index.html" />
<link rel="up" title="Release Notes" href="index.html" />
<link rel="next" title="Release Notes for OpenMC 0.4.4" href="notes_0.4.4.html" />
<link rel="prev" title="Release Notes" href="index.html" />
<link rel="prev" title="Release Notes for OpenMC 0.5.1" href="notes_0.5.1.html" />
</head>
<body>
<div class="header">
@ -41,7 +41,7 @@
<div class="topnav">
<p>
«&#160;&#160;<a href="index.html">Release Notes</a>
«&#160;&#160;<a href="notes_0.5.1.html">Release Notes for OpenMC 0.5.1</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
@ -96,7 +96,7 @@ tangent to a surface.</li>
<div class="bottomnav">
<p>
«&#160;&#160;<a href="index.html">Release Notes</a>
«&#160;&#160;<a href="notes_0.5.1.html">Release Notes for OpenMC 0.5.1</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
@ -107,7 +107,7 @@ tangent to a surface.</li>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

122
releasenotes/notes_0.5.1.html Normal file
View file

@ -0,0 +1,122 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Release Notes for OpenMC 0.5.1 &mdash; OpenMC Documentation</title>
<link rel="stylesheet" href="../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.5.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/theme_extras.js"></script>
<link rel="top" title="OpenMC Documentation" href="../index.html" />
<link rel="up" title="Release Notes" href="index.html" />
<link rel="next" title="Release Notes for OpenMC 0.5.0" href="notes_0.5.0.html" />
<link rel="prev" title="Release Notes" href="index.html" />
</head>
<body>
<div class="header">
<a href="../index.html">
<img class="logo" src="../_static/openmc.png" alt="Logo"/>
</a>
</div>
<div class="topnav">
<p>
«&#160;&#160;<a href="index.html">Release Notes</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="notes_0.5.0.html">Release Notes for OpenMC 0.5.0</a>&#160;&#160;»
</p>
</div>
<div class="content">
<div class="section" id="release-notes-for-openmc-0-5-1">
<span id="notes-0-5-1"></span><h1>Release Notes for OpenMC 0.5.1<a class="headerlink" href="#release-notes-for-openmc-0-5-1" title="Permalink to this headline"></a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">These release notes are for an upcoming release of OpenMC and are still
subject to change.</p>
</div>
<div class="section" id="system-requirements">
<h2>System Requirements<a class="headerlink" href="#system-requirements" title="Permalink to this headline"></a></h2>
<p>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).</p>
</div>
<div class="section" id="new-features">
<h2>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Proper install capability with &#8216;make install&#8217;.</li>
<li>Lattices can now be 2 or 3 dimensions.</li>
<li>New scatter-PN score type.</li>
<li>New kappa-fission score type.</li>
<li>Ability to tally any reaction by specifying MT.</li>
</ul>
</div>
<div class="section" id="bug-fixes">
<h2>Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/63bfd2">63bfd2</a>: Fix tracklength tallies with cell filter and universes.</li>
<li><a class="reference external" href="https://github.com/mit-crpg/openmc/commit/88daf7">88daf7</a>: Fix analog tallies with survival biasing.</li>
</ul>
</div>
</div>
</div>
<div class="bottomnav">
<p>
«&#160;&#160;<a href="index.html">Release Notes</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="notes_0.5.0.html">Release Notes for OpenMC 0.5.0</a>&#160;&#160;»
</p>
</div>
<div class="footer">
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-30411614-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>

2
search.html
View file

@ -86,7 +86,7 @@
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
searchindex.js
View file

File diff suppressed because one or more lines are too long

2
usersguide/beginners.html
View file

@ -185,7 +185,7 @@ and <a class="reference external" href="http://www.hss.doe.gov/nuclearsafety/tec
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

28
usersguide/index.html
View file

@ -64,23 +64,23 @@ essential aspects of using OpenMC to perform neutronic simulations.</p>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">2. Installation and Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#prerequisites">2.1. Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#obtaining-the-source">2.2. Obtaining the Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#build-configuration">2.3. Build Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#compiling-on-linux-and-mac-os-x">2.4. Compiling on Linux and Mac OS X</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#compiling-on-windows">2.5. Compiling on Windows</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-cygwin">2.5.1. Using Cygwin</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-mingw">2.5.2. Using MinGW</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-on-ubuntu-with-ppa">2.1. Installing on Ubuntu with PPA</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#building-from-source">2.2. Building from Source</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#prerequisites">2.2.1. Prerequisites</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#obtaining-the-source">2.2.2. Obtaining the Source</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#build-configuration">2.2.3. Build Configuration</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#compiling-on-linux-and-mac-os-x">2.2.4. Compiling on Linux and Mac OS X</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#compiling-on-windows">2.2.5. Compiling on Windows</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#cross-section-configuration">2.6. Cross Section Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-jeff-cross-sections-from-oecd-nea">2.6.1. Using JEFF Cross Sections from OECD/NEA</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-cross-sections-from-mcnp">2.6.2. Using Cross Sections from MCNP</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-cross-sections-from-serpent">2.6.3. Using Cross Sections from Serpent</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#cross-section-configuration">2.3. Cross Section Configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-jeff-cross-sections-from-oecd-nea">2.3.1. Using JEFF Cross Sections from OECD/NEA</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-cross-sections-from-mcnp">2.3.2. Using Cross Sections from MCNP</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#using-cross-sections-from-serpent">2.3.3. Using Cross Sections from Serpent</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#running-openmc">2.7. Running OpenMC</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#configuring-input-validation-with-gnu-emacs-nxml-mode">2.8. Configuring Input Validation with GNU Emacs nXML mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#running-openmc">2.4. Running OpenMC</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#configuring-input-validation-with-gnu-emacs-nxml-mode">2.5. Configuring Input Validation with GNU Emacs nXML mode</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="input.html">3. Writing XML Input Files</a><ul>
@ -182,7 +182,7 @@ essential aspects of using OpenMC to perform neutronic simulations.</p>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

11
usersguide/input.html
View file

@ -901,7 +901,14 @@ secondary neutrons.</td>
</tr>
<tr class="field-odd field"><th class="field-name">nu-fission:</th><td class="field-body">Total production of neutrons due to fission</td>
</tr>
<tr class="field-even field"><th class="field-name">events:</th><td class="field-body">Number of scoring events</td>
<tr class="field-even field"><th class="field-name">kappa-fission:</th><td class="field-body">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 <img class="math" src="../_images/math/66981fa3920210c6ad8dbe5e968783d5dd7520c3.png" alt="\gamma"/>-ray total energies,
and the total energy released by the delayed <img class="math" src="../_images/math/fdb63b9e51abe6bbb16acfb5d7b773ddbb5bf4a8.png" alt="\beta"/> particles. The
neutrino energy does not contribute to this response. The prompt and delayed
<img class="math" src="../_images/math/66981fa3920210c6ad8dbe5e968783d5dd7520c3.png" alt="\gamma"/>-rays are assumed to deposit their energy locally.</td>
</tr>
<tr class="field-odd field"><th class="field-name">events:</th><td class="field-body">Number of scoring events</td>
</tr>
</tbody>
</table>
@ -1274,7 +1281,7 @@ turned on with &#8220;true&#8221; and off with &#8220;false&#8221;.</p>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

113
usersguide/install.html
View file

@ -54,35 +54,77 @@
<div class="section" id="installation-and-configuration">
<span id="usersguide-install"></span><h1>2. Installation and Configuration<a class="headerlink" href="#installation-and-configuration" title="Permalink to this headline"></a></h1>
<div class="section" id="installing-on-ubuntu-with-ppa">
<h2>2.1. Installing on Ubuntu with PPA<a class="headerlink" href="#installing-on-ubuntu-with-ppa" title="Permalink to this headline"></a></h2>
<p>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:</p>
<div class="highlight-sh"><div class="highlight"><pre>sudo apt-add-repository ppa:paulromano/staging
</pre></div>
</div>
<p>Next, resynchronize the package index files:</p>
<div class="highlight-sh"><div class="highlight"><pre>sudo apt-get update
</pre></div>
</div>
<p>Now OpenMC should be recognized within the repository and can be installed:</p>
<div class="highlight-sh"><div class="highlight"><pre>sudo apt-get install openmc
</pre></div>
</div>
</div>
<div class="section" id="building-from-source">
<h2>2.2. Building from Source<a class="headerlink" href="#building-from-source" title="Permalink to this headline"></a></h2>
<div class="section" id="prerequisites">
<h2>2.1. Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
<p>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 <a class="reference external" href="http://gcc.gnu.org/wiki/GFortran">gfortran</a>, it is recommended that you use version 4.5.0 or above.</p>
<p>If you are using Debian or a Debian derivative such as Ubuntu, you can install
the gfortran compiler using the following command:</p>
<h3>2.2.1. Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h3>
<div class="admonition-required admonition">
<p class="first admonition-title">Required</p>
<ul class="last">
<li><p class="first">A Fortran compiler such as <a class="reference external" href="http://gcc.gnu.org/wiki/GFortran">gfortran</a></p>
<p>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 <a class="reference external" href="http://gcc.gnu.org/wiki/GFortran">gfortran</a>, it is necessary to use
version 4.6.0 or above.</p>
<p>If you are using Debian or a Debian derivative such as Ubuntu, you can
install the gfortran compiler using the following command:</p>
<div class="highlight-python"><pre>sudo apt-get install gfortran</pre>
</div>
<p>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 <a class="reference external" href="http://www.open-mpi.org">OpenMPI</a> and <a class="reference external" href="http://www.mcs.anl.gov/mpi/mpich/">MPICH2</a>. Note that if using OpenMPI, make sure that
&#8211;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:</p>
</li>
</ul>
</div>
<div class="admonition-optional admonition">
<p class="first admonition-title">Optional</p>
<ul class="last">
<li><p class="first">An MPI implementation for distributed-memory parallel runs</p>
<p>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 <a class="reference external" href="http://www.open-mpi.org">OpenMPI</a> and <a class="reference external" href="http://www.mcs.anl.gov/mpi/mpich/">MPICH2</a>. Note that if using
OpenMPI, make sure that &#8211;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:</p>
<div class="highlight-python"><pre>sudo apt-get install mpich2
sudo apt-get install openmpi-bin</pre>
</div>
<p>To compile with support for <a class="reference external" href="http://www.hdfgroup.org/HDF5/">HDF5</a> 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.</p>
<p>To enable CMFD acceleration, you will need to have <a class="reference external" href="http://www.mcs.anl.gov/petsc/">PETSc</a> installed on your
computer. The installed version will need to have been compiled with the same
compiler you intend to compile OpenMC with.</p>
</li>
<li><p class="first"><a class="reference external" href="http://www.hdfgroup.org/HDF5/">HDF5</a> Library for portable binary output format</p>
<p>To compile with support for <a class="reference external" href="http://www.hdfgroup.org/HDF5/">HDF5</a> 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.</p>
</li>
<li><p class="first"><a class="reference external" href="http://www.mcs.anl.gov/petsc/">PETSc</a> for CMFD acceleration</p>
<p>To enable CMFD acceleration, you will need to have <a class="reference external" href="http://www.mcs.anl.gov/petsc/">PETSc</a> installed on
your computer. The installed version will need to have been compiled with
the same compiler you intend to compile OpenMC with.</p>
</li>
<li><p class="first"><a class="reference external" href="http://git-scm.com">git</a> version control software for obtaining source code</p>
</li>
</ul>
</div>
</div>
<div class="section" id="obtaining-the-source">
<h2>2.2. Obtaining the Source<a class="headerlink" href="#obtaining-the-source" title="Permalink to this headline"></a></h2>
<h3>2.2.2. Obtaining the Source<a class="headerlink" href="#obtaining-the-source" title="Permalink to this headline"></a></h3>
<p>All OpenMC source code is hosted on <a class="reference external" href="https://github.com/mit-crpg/openmc">GitHub</a>. You can download the source code
directly from GitHub or, if you have the <a class="reference external" href="http://git-scm.com">git</a> version control software installed
on your computer, you can use git to obtain the source code. The latter method
@ -95,7 +137,7 @@ repository:</p>
</div>
</div>
<div class="section" id="build-configuration">
<h2>2.3. Build Configuration<a class="headerlink" href="#build-configuration" title="Permalink to this headline"></a></h2>
<h3>2.2.3. Build Configuration<a class="headerlink" href="#build-configuration" title="Permalink to this headline"></a></h3>
<p>All configuration for OpenMC is done within the Makefile located in
<tt class="docutils literal"><span class="pre">src/Makefile</span></tt>. In the Makefile, you will see that there are a number of User
Options which can be changed. It is recommended that you do not change anything
@ -132,19 +174,21 @@ Makefile, you can enter the following from a terminal:</p>
</div>
</div>
<div class="section" id="compiling-on-linux-and-mac-os-x">
<h2>2.4. Compiling on Linux and Mac OS X<a class="headerlink" href="#compiling-on-linux-and-mac-os-x" title="Permalink to this headline"></a></h2>
<h3>2.2.4. Compiling on Linux and Mac OS X<a class="headerlink" href="#compiling-on-linux-and-mac-os-x" title="Permalink to this headline"></a></h3>
<p>To compile OpenMC on Linux or Max OS X, run the following commands from within
the root directory of the source code:</p>
<div class="highlight-sh"><div class="highlight"><pre><span class="nb">cd </span>src
make
sudo make install
</pre></div>
</div>
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt>.</p>
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt> and install it (by default in
/usr/local/bin).</p>
</div>
<div class="section" id="compiling-on-windows">
<h2>2.5. Compiling on Windows<a class="headerlink" href="#compiling-on-windows" title="Permalink to this headline"></a></h2>
<h3>2.2.5. Compiling on Windows<a class="headerlink" href="#compiling-on-windows" title="Permalink to this headline"></a></h3>
<div class="section" id="using-cygwin">
<h3>2.5.1. Using Cygwin<a class="headerlink" href="#using-cygwin" title="Permalink to this headline"></a></h3>
<h4>2.2.5.1. Using Cygwin<a class="headerlink" href="#using-cygwin" title="Permalink to this headline"></a></h4>
<p>One option for compiling OpenMC on a Windows operating system is to use <a class="reference external" href="http://cygwin.com/">Cygwin</a>,
a Linux-like environment for Windows. You will need to first <a class="reference external" href="http://cygwin.com/setup.exe">install
Cygwin</a>. When you are asked to select packages, make sure the following are
@ -176,7 +220,7 @@ make
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt>.</p>
</div>
<div class="section" id="using-mingw">
<h3>2.5.2. Using MinGW<a class="headerlink" href="#using-mingw" title="Permalink to this headline"></a></h3>
<h4>2.2.5.2. Using MinGW<a class="headerlink" href="#using-mingw" title="Permalink to this headline"></a></h4>
<p>An alternate option for installing OpenMC on Windows is using <a class="reference external" href="http://www.mingw.org">MinGW</a>, which
stands for Minimalist GNU for Windows. An executable for installing the MinGW
distribution is available on <a class="reference external" href="http://sourceforge.net/projects/mingw">SourceForge</a>. When installing MinGW, make sure the
@ -196,14 +240,15 @@ make
<p>This will build an executable named <tt class="docutils literal"><span class="pre">openmc</span></tt>.</p>
</div>
</div>
</div>
<div class="section" id="cross-section-configuration">
<h2>2.6. Cross Section Configuration<a class="headerlink" href="#cross-section-configuration" title="Permalink to this headline"></a></h2>
<h2>2.3. Cross Section Configuration<a class="headerlink" href="#cross-section-configuration" title="Permalink to this headline"></a></h2>
<p>In order to run a simulation with OpenMC, you will need cross section data for
each nuclide in your problem. Since OpenMC uses ACE format cross sections, you
can use nuclear data that was processed with NJOY, such as that distributed with
<a class="reference external" href="http://mcnp.lanl.gov">MCNP</a> or <a class="reference external" href="http://montecarlo.vtt.fi">Serpent</a>.</p>
<div class="section" id="using-jeff-cross-sections-from-oecd-nea">
<h3>2.6.1. Using JEFF Cross Sections from OECD/NEA<a class="headerlink" href="#using-jeff-cross-sections-from-oecd-nea" title="Permalink to this headline"></a></h3>
<h3>2.3.1. Using JEFF Cross Sections from OECD/NEA<a class="headerlink" href="#using-jeff-cross-sections-from-oecd-nea" title="Permalink to this headline"></a></h3>
<p>The <a class="reference external" href="http://www.oecd-nea.org">NEA</a> provides processed ACE data from the <a class="reference external" href="http://www.oecd-nea.org/dbdata/jeff/">JEFF</a> nuclear library upon
request. A DVD of the data can be requested <a class="reference external" href="http://www.oecd-nea.org/dbdata/pubs/jeff312-cd.html">here</a>. To use this data with OpenMC,
the following steps must be taken:</p>
@ -233,7 +278,7 @@ within the <tt class="docutils literal"><span class="pre">cross_sections.xml</sp
</ol>
</div>
<div class="section" id="using-cross-sections-from-mcnp">
<h3>2.6.2. Using Cross Sections from MCNP<a class="headerlink" href="#using-cross-sections-from-mcnp" title="Permalink to this headline"></a></h3>
<h3>2.3.2. Using Cross Sections from MCNP<a class="headerlink" href="#using-cross-sections-from-mcnp" title="Permalink to this headline"></a></h3>
<p>To use cross sections distributed with MCNP, change the &lt;directory&gt; element in
the <tt class="docutils literal"><span class="pre">cross_sections.xml</span></tt> file in the root directory of the OpenMC distribution
to the location of the MCNP cross sections. Then, either set the
@ -241,7 +286,7 @@ to the location of the MCNP cross sections. Then, either set the
environment variable to the absolute path of the <tt class="docutils literal"><span class="pre">cross_sections.xml</span></tt> file.</p>
</div>
<div class="section" id="using-cross-sections-from-serpent">
<h3>2.6.3. Using Cross Sections from Serpent<a class="headerlink" href="#using-cross-sections-from-serpent" title="Permalink to this headline"></a></h3>
<h3>2.3.3. Using Cross Sections from Serpent<a class="headerlink" href="#using-cross-sections-from-serpent" title="Permalink to this headline"></a></h3>
<p>To use cross sections distributed with Serpent, change the &lt;directory&gt; element
in the <tt class="docutils literal"><span class="pre">cross_sections_serpent.xml</span></tt> file in the root directory of the OpenMC
distribution to the location of the Serpent cross sections. Then, either set the
@ -251,7 +296,7 @@ file.</p>
</div>
</div>
<div class="section" id="running-openmc">
<h2>2.7. Running OpenMC<a class="headerlink" href="#running-openmc" title="Permalink to this headline"></a></h2>
<h2>2.4. Running OpenMC<a class="headerlink" href="#running-openmc" title="Permalink to this headline"></a></h2>
<p>Once you have a model built (see <a class="reference internal" href="input.html#usersguide-input"><em>Writing XML Input Files</em></a>), you can either run
the openmc executable directly from the directory containing your XML input
files, or you can specify as a command-line argument the directory containing
@ -270,7 +315,7 @@ openmc
working directory which may be different from <tt class="docutils literal"><span class="pre">/home/username/somemodel</span></tt>.</p>
</div>
<div class="section" id="configuring-input-validation-with-gnu-emacs-nxml-mode">
<h2>2.8. Configuring Input Validation with GNU Emacs nXML mode<a class="headerlink" href="#configuring-input-validation-with-gnu-emacs-nxml-mode" title="Permalink to this headline"></a></h2>
<h2>2.5. Configuring Input Validation with GNU Emacs nXML mode<a class="headerlink" href="#configuring-input-validation-with-gnu-emacs-nxml-mode" title="Permalink to this headline"></a></h2>
<p>The <a class="reference external" href="http://www.gnu.org/software/emacs/">GNU Emacs</a> text editor has a built-in mode that extends functionality for
editing XML files. One of the features in nXML mode is the ability to perform
real-time <a class="reference external" href="http://en.wikipedia.org/wiki/XML_validation">validation</a> of XML files against a <a class="reference external" href="http://relaxng.org/">RELAX NG</a> schema. The OpenMC
@ -303,7 +348,7 @@ schemas.xml file in your own OpenMC source directory.</p>
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">

2
usersguide/troubleshoot.html
View file

@ -155,7 +155,7 @@ has a collision. For example, if you received this error at cycle 5, generation
<div class="footer">
&copy; Copyright 2011-2012, Massachusetts Institute of Technology.
&copy; Copyright 2011-2013, Massachusetts Institute of Technology.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
<script type="text/javascript">