Tools for atmospheric research
Switch branches/tags
Nothing to show
Clone or download
Latest commit 74b8f22 Oct 19, 2018
Permalink
Failed to load latest commit information.
.github
doc
typhon
.appveyor.yml Check out testfiles repo in CI builds. Oct 5, 2018
.gitignore
.mailmap
.travis.yml Check out testfiles repo in CI builds. Oct 5, 2018
CHANGES
CODE_OF_CONDUCT.md
CONTRIBUTING.md Incorporate suggestions from @lkluft Jul 12, 2018
DESCRIPTION.rst * DESCRIPTION.rst: Adapt. Feb 17, 2016
KNOWN_ISSUES.md
LICENSE
MANIFEST.in
README.md
environment.yml
setup.cfg
setup.py Add dependency on imageio. Aug 13, 2018

README.md

PyPI version Travis AppVeyor Anaconda-Server Badge DOI

typhon - Tools for atmospheric research

Requirements

Typhon requires Python version 3.6 or higher. The recommended way to get Python is through Anaconda. But of course, any other Python distribution is also working.

Installation

The easiest way to develop typhon is to install the cloned working copy in your Python environment. This can be done using pip:

$ git clone https://github.com/atmtools/typhon.git
$ cd typhon
$ pip install --user --editable .

This will install the package in editable mode (develop mode) in the user's home directory. That way, local changes to the package are directly available in the current environment.

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...

$ pytest --pyargs typhon

or using the Python interpreter:

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.

It is also possible to set environment variables in the same-named section of the configuration file, e.g.:

[environment]
ARTS_BUILD_PATH: /path/to/arts/build/

Documentation

A daily build of the documentation is accessible online. Kindly note that bleeding edge features might not be covered.