Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bringing SaltProc repository up to date #47

Merged
merged 10 commits into from
Aug 26, 2020
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@
#
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_show_copyright = False

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
16 changes: 12 additions & 4 deletions doc/examples.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,29 @@
Examples
=========

A number of examples are present in the [examples
directory](https://github.com/arfc/saltproc/tree/master/examples)
provided with the source code.
A number of examples are present in the `examples directory`_ provided with the source code.

.. _examples directory: https://github.com/arfc/saltproc/tree/master/examples

Transatomic Power Molten Salt Reactor example can be run with:


.. code-block:: bash
cd /path/to/saltproc
python saltproc -i examples/tap_main.json
python saltproc -i examples/tap/tap_main.json
In the example above, ``path/to/saltproc`` is, of course, the path to the main
saltproc directory, containing ``setup.py``. The ``tap_main.json`` is the main
Saltproc input file, which contains paths to Serpent input file
(``tap.serpent``), DOT-file with reprocessing scheme (``tap.dot``), and
reprocessing system components' detailed description (``tap_objects.json``).


Similarly, Molten Salt Breeder Reactor example can be run with:


.. code-block:: bash
python saltproc -i examples/msbr/msbr_main.json
18 changes: 16 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SaltProc
=========

Expand Down Expand Up @@ -33,6 +32,7 @@ Documentation
installation
examples
src/index
How to cite <https://github.com/arfc/saltproc/blob/master/CITATION.md>

Indices and tables
------------------
Expand All @@ -42,6 +42,7 @@ Indices and tables
* :ref:`search`



Citation
--------

Expand All @@ -54,10 +55,23 @@ file.
Get in touch
------------

Please report bugs, suggest feature ideas, and browse the source code `on GitHub`_.
- Please report bugs, suggest feature ideas, and browse the source code `on GitHub`_.
- There, new contributors can also find `a guide to contributing`_.
- Good start point for new contributors is `current open issues`_.

.. _a guide to contributing: https://github.com/arfc/saltproc/blob/master/CONTRIBUTING.md
.. _current open issues: https://github.com/arfc/saltproc/issues?q=is%3Aopen+is%3Aissue
.. _on GitHub: http://github.com/arfc/saltproc

Acknowledgment
--------------

SaltProc uses `Shablona`_ template which is universal solution for small
scientific python projects developed at University of Washington `eScience Insititute`_.

.. _Shablona: https://github.com/uwescience/shablona
.. _eScience Insititute: https://escience.washington.edu

License
-------

Expand Down
2 changes: 1 addition & 1 deletion doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Installation

SaltProc has the following dependencies:

#. `Python`_ (>=3.5)
#. `Serpent`_ (>=2.1.31)
#. `PyNE`_ (>=0.5.11)
#. `Python`_ (>=3.5)
#. `NumPy`_ (>=1.14.0)
#. `PyTables`_
#. `NetworkX`_
Expand Down
17 changes: 0 additions & 17 deletions examples/mats/mat_composition.ini

This file was deleted.

728 changes: 728 additions & 0 deletions examples/msbr/geometry/msbr_full.ini

Large diffs are not rendered by default.

Loading