typhon - Tools for atmospheric research
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.
The easiest way to develop typhon is to install the cloned working copy in your
Python environment. This can be done using
$ 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.
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()
Typhon supports a configuration file in
configparser syntax. The
configuration is handled by the
typhon.config module. The default file
~/.typhonrc but can be changed using the
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/
A daily build of the documentation is accessible online. Kindly note that bleeding edge features might not be covered.