Skip to content

SciTools/tephi

Repository files navigation

Tephi

Tephigram plotting in Python

CI Documentation Status Pre-Commit CI Status
Health Coverage Status
Meta Code style: Black
Package Launch MyBinder conda-forge PyPI
Repo GitHub tag (latest by date) GitHub commits since tagged version

Welcome to Tephi!

Installation

conda

Tephi is available on conda-forge, and can be easily installed with conda:

conda install -c conda-forge tephi

or alternatively with mamba:

mamba install -c conda-forge tephi

For more information see the feedstock.

pip

Tephi is available on PyPI:

pip install tephi

Check out our PyPI Download Stats!

Developers

If you simply can't wait for the next release to play with the latest hot features, then you can easily install the main development branch from GitHub:

pip install git+https://github.com/SciTools/tephi@main

Alternatively, to configure a full developer environment, first clone the GeoVista GitHub repository:

git clone [email protected]:SciTools/tephi.git

Change to the root directory:

cd tephi

Create the tephi-dev conda development environment:

mamba env create --file requirements/dev.yml

Now activate the environment and install the main development branch of tephi:

conda activate tephi-dev
pip install --no-deps --editable .

...and you're all set up!

Documentation

The documentation is built by Sphinx and hosted on Read the Docs.

Support

Need help? 😢

Why not check out our existing GitHub issues. See something similar? Well, give it a thumbs up to raise its priority, and feel free to chip in on the conversation. Otherwise, don't hesitate to create a new GitHub issue instead.

However, if you'd rather have a natter, then head on over to our GitHub Discussions.

License

Tephi is distributed under the terms of the BSD-3-Clause license.

Graphics and Lead Scientist: Ed Hawkins, National Centre for Atmospheric Science, University of Reading.

Data: Berkeley Earth, NOAA, UK Met Office, MeteoSwiss, DWD, SMHI, UoR, Meteo France & ZAMG.

#ShowYourStripes is distributed under a Creative Commons Attribution 4.0 International License creative-commons-by