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 latest stable release of typhon can be installed using conda
(recommended)
$ conda install -c rttools typhonor pip
$ pip install typhonCheck our contribution guidelines for information on how to setup a development environment for typhon.
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 typhonor 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
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/
A daily build of the documentation is accessible online. Kindly note that bleeding edge features might not be covered.