Metadata-Version: 2.1
Name: tsunami-ip-utils
Version: 0.1.1
Summary: A tool for visualizing similarity data from the SCALE code: TSUNAMI-IP
License: MIT
Author: Matthew Louis
Author-email: matthewlouis31@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: IPython
Requires-Dist: dash
Requires-Dist: flask
Requires-Dist: h5py
Requires-Dist: kaleido
Requires-Dist: matplotlib
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: plotly (>=5.22.0,<5.23.0)
Requires-Dist: pyprojroot
Requires-Dist: pytest
Requires-Dist: pytest-mpl
Requires-Dist: pyyaml
Requires-Dist: scipy
Requires-Dist: selenium
Requires-Dist: tqdm
Requires-Dist: uncertainties
Requires-Dist: webdriver-manager
Project-URL: Documentation, https://mlouis9.github.io/tsunami_ip_utils
Project-URL: Homepage, https://github.com/mlouis9/tsunami_ip_utils
Project-URL: Issues, https://github.com/mlouis9/tsunami_ip_utils/issues
Description-Content-Type: text/markdown

# Introduction
This is a python package created to provide enhanced visualization capabilities for criticality safety similarity indices calculated by
[TSUNAMI-IP](https://scale-manual.ornl.gov/tsunami-ip.html#tsunami-ip): a code in the Standardized Computer Analysis for Licensing Evaluation ([SCALE](https://scale-manual.ornl.gov/)) suite. These methods are still under development and are *not* intended for
production use, but can be nice as an exploratory tool.

# Installation and Setup
This package is [published on PyPI](https://pypi.org/project/tsunami-ip-utils/), and so can be installed (along with all of the necessary dependencies) via `pip`
```
pip install tsunami_ip_utils
```

# Documentation and Examples
If you're interested in running some examples, just clone this repository via the instructions [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository#cloning-a-repository) and navigate to the `examples` directory.
More detailed instructions (in a human readable form) can be found in [the documentation](https://mlouis9.github.io/tsunami_ip_utils/),
along with a description of the theory behind the visualization tools, and a fully documented API.

