crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-29 06:35:48 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Merge pull request #1782 from gridley/address_1775

Browse source 
add warnings about untrusted OpenMC models to user guide
This commit is contained in:
Paul Romano 2021-03-08 06:42:56 -06:00 • committed by GitHub
commit 84d501e0b1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/usersguide/basics.rst
View file

@ -5,13 +5,13 @@ Basics of Using OpenMC
======================
----------------
Creating a Model
Running a Model
----------------
When you build and install OpenMC, you will have an :ref:`scripts_openmc`
executable on your system. When you run ``openmc``, the first thing it will do
is look for a set of XML_ files that describe the model you want to
simulation. Three of these files are required and another three are optional, as
simulate. Three of these files are required and another three are optional, as
described below.
.. admonition:: Required
@ -43,6 +43,10 @@ described below.
This file gives specifications for producing slice or voxel plots of the
geometry.
.. warning::
OpenMC models should be treated as code, and it is important to be careful with code from untrusted sources.
eXtensible Markup Language (XML)
--------------------------------

8
docs/source/usersguide/scripts.rst
View file

@ -13,7 +13,13 @@ Executables and Scripts
Once you have a model built (see :ref:`usersguide_basics`), 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 your XML input files are in the directory
the XML input files.
.. warning::
OpenMC models should be treated as code, and it is important to be careful with code from untrusted sources.
For example, if your XML input files are in the directory
``/home/username/somemodel/``, one way to run the simulation would be:
.. code-block:: sh