Welcome to tsunami_ip_utils’s documentation!
This is the documentation for tsunami_ip_utils, a python package for providing enhanced visualization capabilities for criticality safety similarity indices calculated by TSUNAMI-IP: a code in the Standardized Computer Analysis for Licensing Evaluation (SCALE) suite. These methods are still under development and are not intended for production use, but can be nice as an exploratory tool.
NOTE: This package requires SCALE to be installed and the binaries to be on the system path. SCALE is an export controlled code and can be requested from RSICC.
The documentation is organized into a public API (i.e. all functions that are intended to be used by users, and whose interface will not change without a deprecation warning) and a private API (i.e. all functions that are not intended to be used by users, and whose interface may change without a deprecation warning). The public API is the recommended way to interact with the package, while the private API is intended for developers who wish to extend the package.
Contents:
- Public API
- Subpackages
- Submodules
- tsunami_ip_utils.comparisons module
- tsunami_ip_utils.config module
- tsunami_ip_utils.integral_indices module
- tsunami_ip_utils.perturbations module
- tsunami_ip_utils.readers module
- tsunami_ip_utils.utils module
- tsunami_ip_utils.xs module
- SCALE Template Input Files
- Module contents
- Private API
- Subpackages
- Submodules
- tsunami_ip_utils._error module
- tsunami_ip_utils.comparisons module
- tsunami_ip_utils.config module
- tsunami_ip_utils.integral_indices module
- tsunami_ip_utils.perturbations module
- tsunami_ip_utils.readers module
- tsunami_ip_utils.utils module
- tsunami_ip_utils.xs module
- Module contents
- Paths
- Examples
- Report