Metadata-Version: 2.1
Name: sim-solps
Version: 0.1.2
Summary: Synthetic instrument modelling for SOLPS-ITER
Home-page: https://github.com/C-bowman/sim-solps
Author: Chris Bowman
Author-email: chris.bowman.physics@gmail.com
License: MIT
Project-URL: Source, https://github.com/C-bowman/sim-solps
Project-URL: Tracker, https://github.com/C-bowman/sim-solps/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy (>=1.8)
Requires-Dist: scipy (>=1.6.3)
Requires-Dist: matplotlib (>=3.4.2)
Requires-Dist: tokamesh (>=0.2.0)
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: docs
Requires-Dist: sphinx (~=3.5.4) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest (>=3.3.0) ; extra == 'tests'
Requires-Dist: pytest-cov (>=3.0.0) ; extra == 'tests'

# sim-solps
sim-solps is a python package which provides synthetic-instrument modelling for SOLPS-ITER.

## Features
 - The [`SolpsInterface`](https://github.com/C-bowman/sim-solps/blob/main/demos/SolpsInterface_demo.ipynb) class, which provides a convenient python interface to access the
   results of SOLPS-ITER simulations stored in `balance.nc` files.
 - Instrument modelling for Thomson scattering systems as the [`ThomsonScattering`](https://github.com/C-bowman/sim-solps/blob/main/demos/ThomsonScattering_demo.ipynb) class.

## Installation
sim-solps is available from [PyPI](https://pypi.org/project/sim-solps/), 
so can be easily installed using [pip](https://pip.pypa.io/en/stable/) as follows:
```bash
pip install sim-solps
```

## Documentation
The package documentation is available at [sim-solps.readthedocs.io](https://sim-solps.readthedocs.io/).
