Skip to content

arfc/saltproc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

973d321 · Feb 19, 2025
May 29, 2019
Jan 15, 2025
Feb 19, 2025
Aug 30, 2023
Feb 19, 2025
Jul 25, 2023
Aug 30, 2023
Feb 17, 2023
Oct 4, 2017
May 22, 2024
Dec 18, 2019
Jan 21, 2020
Feb 1, 2022
Mar 30, 2018
Oct 4, 2017
Jan 19, 2023
Apr 20, 2023
Jul 29, 2022
Apr 20, 2023
Apr 5, 2023

Repository files navigation

SaltProc

Build Status

The SaltProc is a fuel reprocessing simulation tool for liquid fueled nuclear reactors.

How to run SaltProc:

cd /path/to/saltproc python saltproc -s 2 -i examples/tap/tap_main.json

-s          number of threads to use for shared-memory paralleism (optional)
-i          path and name of SaltProc main input file

Installation

Detailed installation instructions can be found in the User's Guide.

Documentation

The documentation for SaltProc can be found at arfc.github.io/saltproc/. The entire contents of that website can be built from the doc directory in the repositiory using the following steps with the conda tool:

  1. conda env create -f doc/doc-environment.yml
  2. cd doc/
  3. make clean
  4. make html

After these steps, the website will be found in saltproc/doc/_build/html.

Note: We recommend using mamba CLI tool to install packages quickly. SaltProc has a compltex package dependency structure which can result is long environment solve times in the default conda solver. mamba is a reimplementation of conda in C++ and we have found it is significantly faster.

License

The license for this work can be found here. Please be respectful of my intellectual work by communicating with me about its use, understanding its limitations, and citing me where appropriate. We would be thrilled to work with you on improving it.

Contributions

This repository is a work in progress. We would love it if you wanted to contribute to this code here in this repository. Here is some information about how to do that..