Metadata-Version: 2.1
Name: neutralocean
Version: 0.0.16
Summary: Neutral Surfaces in the Ocean
Home-page: https://github.com/geoffstanley/neutralocean
Author: Geoff Stanley
Author-email: g.stanley@unsw.edu.au
License: MIT
Keywords: oceanography
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Education
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: xarray
Requires-Dist: scipy
Requires-Dist: scikit-sparse
Requires-Dist: gsw
Requires-Dist: pooch

# neutralocean
Calculate neutral surfaces in the ocean, using Python

# Installation
If you use pip, simply execute
```
$ pip install neutralocean
```

If you use conda, we're going to still use pip because I haven't uploaded `neutralocean` to conda-forge yet.  I will do that soon.  In the meantime, it's probably best to install the main dependencies from conda-forge, first.  
```
$ conda install -c conda-forge numba numpy scipy scikit-sparse xarray gsw pip pooch
```
Now that we've got most things from conda-forge, we'll get just `neutralocean` from pip:
```
$ pip install neutralocean
```


# Usage
Try running the example script:
```
python /path/to/neutralocean/neutralocean/examples/run_OCCA.py
```
If that runs, we're in business.  
Take a look at that example script, `run_OCCA.py` located in `neutralocean/examples/`.
It is documented and will walk you through loading an ocean model dataset, selecting an equation of state, calculating various approximately neutral surfaces, and more. 
