From 08bda29d3727340c5f77f610dcd6da9f066720d4 Mon Sep 17 00:00:00 2001 From: Paul Romano Date: Sun, 1 Apr 2012 14:37:54 -0400 Subject: [PATCH] More updates to documentation. --- docs/source/index.rst | 1 + docs/source/license.rst | 24 +++++++++++++ docs/source/usersguide/input.rst | 25 +++++++++++++ docs/source/usersguide/setup.rst | 62 +++++++++++++++++++++++++++----- 4 files changed, 104 insertions(+), 8 deletions(-) create mode 100644 docs/source/license.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 5b8bebff35..eb9775b77c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -29,4 +29,5 @@ Contents usersguide/index devguide/index publications + license developers diff --git a/docs/source/license.rst b/docs/source/license.rst new file mode 100644 index 0000000000..e8ebbaad1e --- /dev/null +++ b/docs/source/license.rst @@ -0,0 +1,24 @@ +.. _license: + +================= +License Agreement +================= + +Copyright © 2011-2012 Massachusetts Institute of Technology + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/docs/source/usersguide/input.rst b/docs/source/usersguide/input.rst index 32f63bbcfa..f6104bba4c 100644 --- a/docs/source/usersguide/input.rst +++ b/docs/source/usersguide/input.rst @@ -210,6 +210,31 @@ integers: the batch number, generation number, and particle number. *Default*: None +```` Element +------------------------ + +The ```` element describes a mesh that is used for re-weighting +source sites at every generation based on the uniform fission site methodology +described in Kelly et al., "MC21 Analysis of the Nuclear Energy Agency Monte +Carlo Performance Benchmark Problem," Proceedings of *Physor 2012*, Knoxville, +TN (2012). This mesh should cover all possible fissionable materials in the +problem. It has the following attributes/sub-elements: + + :dimension: + The number of mesh cells in the x, y, and z directions, respectively. + + *Default*: None + + :lower_left: + The Cartersian coordinates of the lower-left corner of the mesh. + + *Default*: None + + :upper_right: + The Cartersian coordinates of the upper-right corner of the mesh. + + *Default*: None + ```` Element ----------------------- diff --git a/docs/source/usersguide/setup.rst b/docs/source/usersguide/setup.rst index a148000c77..b49eb08d42 100644 --- a/docs/source/usersguide/setup.rst +++ b/docs/source/usersguide/setup.rst @@ -41,9 +41,11 @@ been compiled with the same compiler you intend to compile OpenMC with. Obtaining the Source -------------------- -All OpenMC source code is hosted on GitHub_. This means that you will need to -have git_ installed on your computer in order to get source code and updates -directly from the repository. GitHub has a good set of `instructions +All OpenMC source code is hosted on GitHub_. You can download the source code +directly from GitHub or, if you have the git_ version control software installed +on your computer, you can use git to obtain the source code. The latter method +has the benefit that it is easy to receive updates directly from the GitHub +repository. GitHub has a good set of `instructions `_ for how to set up git to work with GitHub since this involves setting up ssh_ keys. With git installed and setup, the following command will download the full source code from the GitHub @@ -96,12 +98,12 @@ Makefile, you can enter the following from a terminal:: make DEBUG=yes ---------- -Compiling ---------- +------------------------------- +Compiling on Linux and Mac OS X +------------------------------- -To compile the code, run the following commands from within the root directory -for OpenMC: +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 @@ -110,6 +112,25 @@ for OpenMC: 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/ + --------------------------- Cross-Section Configuration --------------------------- @@ -130,3 +151,28 @@ directory of the OpenMC distribution to the location of the Serpent cross-sections. Then, either set the :ref:`cross_sections` in a settings.xml file or the :envvar:`CROSS_SECTIONS` environment variable to the absolute path of the ``cross_sections_serpent.xml`` file. + +-------------- +Running OpenMC +-------------- + +Once you have a model built (see :ref:`usersguide_input`), 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 +the XML input files. For example, if the path of your OpenMC exectuable is +``/home/username/openmc/src/openmc`` and your XML input files are in the +directory ``/home/username/somemodel/``, one way to run the simulation would be: + +.. code-block:: sh + + cd /home/username/somemodel + openmc + +Alternatively, you could run from any directory: + +.. code-block:: sh + + openmc /home/username/somemodel + +Note that in the latter case, any output files will be placed in the present +working directory which may be different from ``/home/username/somemodel``.