Tephigram plotting in Python
| | |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CI | [](https://readthedocs.org/projects/tephi/) [](https://results.pre-commit.ci/latest/github/SciTools/tephi/main) |
| Health | [](https://coveralls.io/github/SciTools/tephi?branch=main) |
| Meta | [](https://github.com/psf/black) |
| Package | [](https://mybinder.org/v2/gh/SciTools/tephi/main?filepath=index.ipynb) [](https://anaconda.org/conda-forge/tephi) [](https://pypi.org/project/tephi/) |
| Repo | [](https://github.com/SciTools/tephi/releases) [](https://github.com/SciTools/tephi/commits/main) |
| | |
# Welcome to Tephi!
## Installation
### conda
Tephi is available on [conda-forge](https://anaconda.org/conda-forge/tephi), and can be easily installed with [conda](https://docs.conda.io/projects/conda/en/latest/index.html):
```shell
conda install -c conda-forge tephi
```
or alternatively with [mamba](https://github.com/mamba-org/mamba):
```shell
mamba install -c conda-forge tephi
```
For more information see the [feedstock](https://github.com/conda-forge/tephi-feedstock).
### pip
Tephi is available on [PyPI](https://pypi.org/project/tephi/):
```shell
pip install tephi
```
Check out our [PyPI Download Stats!](https://pypistats.org/packages/tephi)
## 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:
```shell
pip install git+https://github.com/SciTools/tephi@main
```
Alternatively, to configure a full developer environment, first clone the GeoVista GitHub repository:
```shell
git clone git@github.com:SciTools/tephi.git
```
Change to the root directory:
```shell
cd tephi
```
Create the `tephi-dev` conda development environment:
```shell
mamba env create --file requirements/dev.yml
```
Now activate the environment and install the `main` development branch of tephi:
```shell
conda activate tephi-dev
pip install --no-deps --editable .
```
...and you're all set up!
## Documentation
The [documentation](https://tephi.readthedocs.io/en/latest/) is built by [Sphinx](https://www.sphinx-doc.org/en/master/) and hosted on [Read the Docs](https://docs.readthedocs.io/en/stable/).
## Support
Need help? 😢
Why not check out our [existing GitHub issues](https://github.com/SciTools/tephi/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](https://github.com/SciTools/tephi/issues/new/choose) instead.
However, if you'd rather have a natter, then head on over to our
[GitHub Discussions](https://github.com/SciTools/tephi/discussions).
## License
Tephi is distributed under the terms of the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) license.
## [#ShowYourStripes](https://showyourstripes.info/s/globe)
**Graphics and Lead Scientist**: [Ed Hawkins](http://www.met.reading.ac.uk/~ed/home/index.php), 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
