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.

The latest stable release of typhon can be installed using conda (recommended)

$ conda install -c rttools typhon

or pip

$ pip install typhon

Check our 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 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 location is ~/.typhonrc but can be changed using the TYPHONRC environment variable.

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