Skip to content

README.md

Latest commit

 

History

History
72 lines (44 loc) · 1.51 KB

README.md

File metadata and controls

72 lines (44 loc) · 1.51 KB

NIS

Nuclear Inventory Simulator

Dependencies

  • Eigen (For matrix manipulation and solvers)
  • ENDFtk (For reading ENDF files)
  • Catch2 (For unit testing)

ENDFtk has its own dependencies, which are all header only but need to be pulled locally too.

All dependencies are header only, so only include paths need to be set.

If you follow the script in docker/setup_local_deps.sh, running it in the root directory of this repository, it should setup all the correct dependencies as needed.

Build

Once you have all the dependencies locally, you can then compile via:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make -j4

python bindings

If you want the python bindings (default=OFF), then follow the below steps.

First make a virtual env and install pybind via:

python3 -m venv venv
source venv/bin/activate
python3 -m install pybind11

Then build as before but with slightly different cmake args, as below.

source venv/bin/activate
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_PY_API=ON -Dpybind11_DIR=`pybind11-config --cmakedir` ..
make -j4

Example

To test your build, after compiling as above, try the following:

./build/bin/nis --data ./data/jeff311.dec --input examples/h3_halflife.inp

If successful, you should see roughly half remains as H3 and the other half has beta decayed to He3.

H3 5.00518e+19
He3 4.99482e+19

Note, you will need to have pulled the decay data via LFS in the ./data subdirectory.