https://github.com/arfc/saltproc
Online reprocessing for molten salt reactors
https://github.com/arfc/saltproc
molten-salt molten-salt-reactors nuclear-engineering software
Last synced: 26 days ago
JSON representation
Online reprocessing for molten salt reactors
- Host: GitHub
- URL: https://github.com/arfc/saltproc
- Owner: arfc
- License: other
- Created: 2017-10-03T14:27:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T23:48:14.000Z (11 months ago)
- Last Synced: 2025-02-20T00:32:41.946Z (11 months ago)
- Topics: molten-salt, molten-salt-reactors, nuclear-engineering, software
- Language: MATLAB
- Size: 51.4 MB
- Stars: 20
- Watchers: 5
- Forks: 16
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Citation: CITATION.md
Awesome Lists containing this project
- awesome-nuclear - SaltProc
README
## SaltProc
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](https://arfc.github.io/saltproc/master/installation.html).
### Documentation
The documentation for SaltProc can be found at
[arfc.github.io/saltproc/](http://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`](https://docs.conda.io/en/latest/) 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`](https://github.com/mamba-org/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](https://github.com/arfc/saltproc/blob/master/LICENSE). 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.](https://github.com/arfc/saltproc/blob/master/CONTRIBUTING.md).