Skip to content

A modular toolkit of fast and reliable libraries for neutronics analysis. Several command line tools are built with this core collection of crates.

License

Notifications You must be signed in to change notification settings

repositony/ntools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Neutronics toolbox

Build Status Documentation

A modular toolkit of fast and reliable libraries for neutronics analysis

The full library documentation is published here

This is a pre-release version for testing and development, with the API subject to change until a stable 1.0 release.

Library overview

The ntools toolkit contains a collection of mostly modular libraries for common fusion neutronics tasks and analysis.

Crate Description
fispact Analysis tools for FISPACT-II inventory calculations
iaea Module for interacting with the IAEA decay data API
mesh MCNP mesh tally operations and file parsing
posvol Se/deserialiser for UKAEA CuV posvol binaries
utils Common utilities and extension traits
weights Tools for MCNP weight window operations
wwgen Weight window generation methods for MCNP

Command line tools built on these core libraries are maintained in their own repositories.

Modular crates

The ntools crates are included as dependencies through feature flags. Specify "full" to include everything.

[dependencies]
ntools = { git = "https://github.com/repositony/ntools.git", features = ["full"] }

It is recommended that users are more selective to avoid compiling unnecessary dependencies.

For example, if only the fispact and iaea crates are needed:

[dependencies]
ntools = { git = "https://github.com/repositony/ntools.git", features = ["fispact", "iaea"] }

Documentation and Tests

To reproduce the full library documentation seen here:

cargo doc --workspace --no-deps --features full

To run all tests for all modules, use the --workspace flag.

cargo test --workspace

About

A modular toolkit of fast and reliable libraries for neutronics analysis. Several command line tools are built with this core collection of crates.

Topics

Resources

License

Stars

Watchers

Forks

Languages