Metadata-Version: 2.1
Name: typhon
Version: 0.10.0
Summary: Typhon is a collection of tools for atmospheric research.
Home-page: https://github.com/atmtools/typhon
Download-URL: https://github.com/atmtools/typhon/tarball/v0.10.0
Author: The Typhon developers
Author-email: The Typhon developers <typhon.mi@lists.uni-hamburg.de>
License: MIT License
Project-URL: Homepage, https://github.com/atmtools/typhon
Project-URL: Repository, https://github.com/atmtools/typhon
Project-URL: Issues, https://github.com/atmtools/typhon/issues
Keywords: one,two
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: ~=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: docutils
Requires-Dist: fsspec !=2023.12.0,!=2023.12.1,!=2024.3.1
Requires-Dist: h5netcdf
Requires-Dist: imageio
Requires-Dist: matplotlib >=1.4
Requires-Dist: netCDF4 >=1.1.1
Requires-Dist: numexpr
Requires-Dist: numpy >=1.13
Requires-Dist: pandas
Requires-Dist: scikit-image
Requires-Dist: scikit-learn
Requires-Dist: scipy >=0.15.1
Requires-Dist: xarray >=0.10.2
Provides-Extra: docs
Requires-Dist: cartopy ; extra == 'docs'
Requires-Dist: pint ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pint ; extra == 'tests'

[![PyPI version](https://badge.fury.io/py/typhon.svg)](https://badge.fury.io/py/typhon)
[![Conda version](https://anaconda.org/rttools/typhon/badges/version.svg)](https://anaconda.org/rttools/typhon)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1300318.svg)](https://doi.org/10.5281/zenodo.1300318)
![Test](https://github.com/atmtools/typhon/actions/workflows/build-test.yml/badge.svg)

# typhon - Tools for atmospheric research

## Installation
Typhon requires Python version 3.10 or higher. The recommended way to get Python
is through [Miniforge3]. But of course, any other Python distribution is also
working.

### Stable release
The latest stable release of typhon can be installed using ``conda`` 
(recommended)
```bash
$ conda install -c rttools typhon
```
or ``pip``
```bash
$ pip install typhon
```

### Development version
Check our information on how to [setup a development environment](CONDA-ENV.md)
for typhon.

## Testing
Typhon contains a simple testing framework using [pytest]. It is good
practice to write tests for all your functions and classes. Those tests may not
be too extensive but should cover the basic use cases to ensure correct
behavior through further development of the package.

Tests can be run on the command line...
```bash
$ pytest --pyargs typhon
```
or using the Python interpreter:
```python
import typhon
typhon.test()
```

## Configuration
Typhon supports a configuration file in ``configparser`` syntax. The
configuration is handled by the ``typhon.config`` module. The default file
location is ``~/.typhonrc`` but can be changed using the ``TYPHONRC``
environment variable.

## Documentation
A recent build of the documentation is accessible
[online](http://radiativetransfer.org/misc/typhon/doc-trunk).
Kindly note that bleeding edge features might not be covered.

[Sphinx]: http://www.sphinx-doc.org
[Miniforge3]: https://github.com/conda-forge/miniforge#miniforge
[pytest]: https://docs.pytest.org/
