https://github.com/atmtools/typhon

Tools for atmospheric research
https://github.com/atmtools/typhon

atmospheric-science python python3 radiative-transfer science

Last synced: 4 days ago
JSON representation

Tools for atmospheric research

• Host: GitHub
• URL: https://github.com/atmtools/typhon
• Owner: atmtools
• License: mit
• Created: 2015-10-19T07:07:24.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-05T11:03:11.000Z (4 months ago)
• Last Synced: 2024-10-29T21:01:21.873Z (10 days ago)
• Topics: atmospheric-science, python, python3, radiative-transfer, science
• Language: Python
• Homepage: http://www.radiativetransfer.org/
• Size: 5.44 MB
• Stars: 59
• Watchers: 14
• Forks: 32
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-meteo - typhon
• open-sustainable-technology - typhon - A collection of tools for atmospheric research with Python 3. (Atmosphere / Atmospheric Composition and Dynamics)

README

        
[![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/