Metadata-Version: 2.0
Name: SPINSpy
Version: 1.0.0
Summary: A set of python tools for processing SPINS outputs.
Home-page: https://git.uwaterloo.ca/bastorer/SPINSpy
Author: Ben Storer
Author-email: bastorer@uwaterloo.ca
License: UNKNOWN
Project-URL: Documentation, https://git.uwaterloo.ca/bastorer/SPINSpy/wikis/home
Project-URL: Source, https://git.uwaterloo.ca/bastorer/SPINSpy
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# SPINSpy

SPINSpy adds a collection of python packages to process [SPINS](https://git.uwaterloo.ca/SPINS/SPINS_main) simulation outputs.

## Installation
The easiest installation method is with pip.
 - e.g.: *pip install --user SPINSpy*

To install SPINSpy, simply put it somewhere and add it to you python path.
 - e.g.: *\<path\>/SPINSpy*

In *~/.bash_profile*, add 
 - export PYTHONPATH="\<path\>/SPINSpy:$PYTHONPATH"

## Documentation

Documention is available at https://git.uwaterloo.ca/bastorer/SPINSpy/wikis/home.

[SPINS](https://git.uwaterloo.ca/SPINS/SPINS_main) includes a set of post-processing scripts that use the SPINSpy tools to generate a series of diagnostic figures.


