Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

tobac

A Python package for identifiying, tracking and analysing of clouds and other meteorological phenomena in different types of gridded datasets.
https://github.com/tobac-project/tobac

Category: Atmosphere
Sub Category: Atmospheric Chemistry and Aerosol

Keywords

cloud tracking

Keywords from Contributors

closember pyart radar-processing weather-radars

Last synced: about 12 hours ago
JSON representation

Repository metadata

Tracking and object-based analysis of clouds

README.md

tobac - Tracking and Object-based Analysis of Clouds

Release VersionDownload CounterDocumentation Status

What is it?

tobac is a Python package for identifiying, tracking and analysing of clouds and other meteorological phenomena in different types of gridded datasets. tobac is unique in its ability to track phenomena using any variable on any grid, including radar data, satellite observations, and numerical model output. tobac has been used in a variety of peer-reviewed publications and is an international, multi-institutional collaboration.

Documentation

Individual features are identified as either maxima or minima in a two dimensional time varying field.
The volume/area associated with the identified objects can be determined based on a time-varying 2D or 3D field and a threshold value. The in thre tracking step, the identified objects are linked into consistent trajectories representing the cloud over its lifecycle.

Detailed documentation of the package can be found at https://tobac.readthedocs.io.

Release announcements, workshop and conference announcements, and other information of interest to the broader tobac users group are sent to the tobac core group mailing list. If you are interested in contributing to the development of tobac, we invite you to join the tobac developers mailing list. Information on monthly developers' meetings and other developer discussion and announcements are sent to that list.

We also have a Slack server for both users and developers. For information on joining that, please contact the tobac developers mailing list, or see the information in the tobac release notes sent to the tobac mailing list.

Installation

tobac requires Python 3, and support for Python versions before 3.7 (i.e., 3.6 and lower) is deprecated and will be removed in tobac version 1.5.

The easiest way is to install the most recent version of tobac via conda and the conda-forge channel:

conda install -c conda-forge tobac

This will take care of all necessary dependencies and should do the job for most users and also allows for an easy update of the installation by

conda update -c conda-forge tobac

You can also install conda via git, either for development purposes or to use specific development branches for the Github repository.

If you are using anaconda, the following command from within the cloned repository should make sure all dependencies are met and up to date:

conda install -c conda-forge --yes --file requirements.txt

You can directly install the package directly from github with pip and either of the two following commands:

pip install --upgrade git+ssh://git@github.com/tobac-project/tobac.git
pip install --upgrade git+https://github.com/tobac-project/tobac.git

You can also clone the package with any of the two following commands

git clone git@github.com:tobac-project/tobac.git
git clone https://github.com/tobac-project/tobac.git

and install the package from the locally cloned version:

pip install tobac/

Contributing

We encourage bug reports, questions, and code contributions. For more details on contributing, please see https://github.com/tobac-project/tobac/blob/v2.0-dev/CONTRIBUTING.md

We are currently in a transition phase between versions 1.x and 2.x. v2.x will enable the use of multiple tracking methods (including TINT) and will use xarray for gridded data instead of Iris. Preliminary development on v2.x has taken place on the v2.0-dev branch, while work on the main and RC_v1.x.x branches (containing v1.x development) is ongoing to unify these development efforts.

Roadmap

A roadmap for the future development of tobac is available here: https://github.com/tobac-project/tobac-roadmap/blob/master/tobac-roadmap-main.md

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 1,567
Total Committers: 17
Avg Commits per committer: 92.176
Development Distribution Score (DDS): 0.68

Commits in past year: 209
Committers in past year: 5
Avg Commits per committer in past year: 41.8
Development Distribution Score (DDS) in past year: 0.512

Name Email Commits
Sean Freeman s****n@u****u 502
William Jones w****s@p****k 333
Max Heikenfeld m****d@w****e 270
Juli j****s@g****e 131
Nils Pfeifer n****r@p****m 88
Julia Kukulies k****s@u****u 48
Fabian Senf s****f@t****e 43
Kolya Lettl k****l@p****t 35
Sven-248 s****n@g****m 27
kukulies k****s@m****u 25
fziegner F****r@g****e 23
kelcyno 8****o 21
galexsky 9****y 17
Bhupendra b****t@g****m 1
Eric Bruning e****g@g****m 1
JuliaKukulies k****s@m****u 1
Xin Zhang x****5@g****m 1

Committer domains:

Issue and Pull Request metadata

Last synced: 3 days ago

Total issues: 165
Total pull requests: 199
Average time to close issues: 6 months
Average time to close pull requests: 2 months
Total issue authors: 25
Total pull request authors: 12
Average comments per issue: 2.68
Average comments per pull request: 5.16
Merged pull request: 159
Bot issues: 0
Bot pull requests: 0

Past year issues: 28
Past year pull requests: 38
Past year average time to close issues: 19 days
Past year average time to close pull requests: 27 days
Past year issue authors: 9
Past year pull request authors: 5
Past year average comments per issue: 1.39
Past year average comments per pull request: 4.16
Past year merged pull request: 20
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/tobac-project/tobac

Top Issue Authors

  • freemansw1 (56)
  • w-k-jones (46)
  • JuliaKukulies (20)
  • fsenf (8)
  • wreckdump (6)
  • deeplycloudy (3)
  • snilsn (3)
  • zhangzh1118 (2)
  • lettlini (2)
  • mheikenfeld (2)
  • sgupta92 (2)
  • Sven-248 (2)
  • sortland33 (1)
  • lk337 (1)
  • zxdawn (1)

Top Pull Request Authors

  • w-k-jones (73)
  • freemansw1 (62)
  • JuliaKukulies (27)
  • fsenf (11)
  • lettlini (9)
  • Sven-248 (5)
  • fziegner (5)
  • snilsn (3)
  • MatthewDyerOSU (1)
  • kelcyno (1)
  • galexsky (1)
  • jcssouza (1)

Top Issue Labels

  • bug (52)
  • enhancement (40)
  • Low Priority (17)
  • documentation (16)
  • question (15)
  • good first issue (13)
  • release (11)
  • workflow (8)
  • to be deleted? (7)
  • dependency (7)
  • xarray transition (6)
  • v2.x compatibility (6)
  • Tobathon (6)
  • discussion (5)
  • Small Change (5)
  • In Review (4)
  • Refactor (3)
  • High Priority (3)
  • Tobathon 2025 (3)

Top Pull Request Labels

  • enhancement (52)
  • bug (41)
  • documentation (23)
  • xarray transition (12)
  • release (11)
  • Small Change (10)
  • Refactor (6)
  • High Priority (5)
  • Tobathon 2025 (5)
  • v2.x compatibility (2)
  • Tobathon (2)
  • In Review (1)
  • workflow (1)

Package metadata

pypi.org: tobac

A package for identifying and tracking atmospheric phenomena

  • Homepage: http://github.com/tobac-project/tobac
  • Documentation: http://tobac.io
  • Licenses:
  • Latest release: 1.6.2 (published 4 days ago)
  • Last Synced: 2025-12-22T15:46:07.835Z (4 days ago)
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Docker Downloads: 317
  • Rankings:
    • Dependent packages count: 8.12%
    • Average: 27.013%
    • Dependent repos count: 45.906%
  • Maintainers (1)
conda-forge.org: tobac

tobac is a flexible frameork for cloud tracking of different types of datasets

  • Homepage: https://github.com/tobac-project/tobac
  • Licenses: BSD-3-Clause
  • Latest release: 1.3.3 (published over 3 years ago)
  • Last Synced: 2025-12-01T12:28:55.653Z (25 days ago)
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Rankings:
    • Dependent repos count: 24.377%
    • Forks count: 27.631%
    • Average: 35.127%
    • Stargazers count: 36.908%
    • Dependent packages count: 51.589%

Dependencies

.github/workflows/check_formatting.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/codecov-CI.yml actions
  • actions/checkout v2 composite
  • codecov/codecov-action v3 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/docker-image.yml actions
  • actions/checkout v2 composite
tobac/tests/Dockerfile docker
  • mambaorg/micromamba latest build
doc/requirements.txt pypi
  • ipykernel *
  • nbsphinx *
.github/workflows/check_json.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/pylint.yml actions
  • actions/checkout v4 composite
  • mamba-org/setup-micromamba v1 composite
  • peter-evans/create-or-update-comment v3 composite
  • peter-evans/find-comment v2 composite
requirements.txt pypi
  • cartopy *
  • iris *
  • matplotlib *
  • numpy *
  • pandas *
  • scikit-image *
  • scikit-learn *
  • scipy *
  • trackpy *
  • typing_extensions *
  • xarray *
setup.py pypi
.github/workflows/matrix_ci.yml actions
  • actions/checkout v2 composite
  • mamba-org/setup-micromamba v1 composite
.github/workflows/check_notebooks.yml actions
  • actions/checkout v3 composite
  • mamba-org/setup-micromamba v1 composite
example_requirements.txt pypi
  • arm_pyart *
  • cartopy *
  • dask *
  • h5netcdf *
  • iris *
  • jupyter *
  • matplotlib *
  • notebook *
  • numba *
  • numpy *
  • pandas *
  • pytables *
  • rioxarray *
  • s3fs *
  • scikit-image *
  • scikit-learn *
  • scipy *
  • seaborn *
  • trackpy *
  • typing_extensions *
  • xarray *
pyproject.toml pypi
dev_requirements.txt pypi
  • black * development
  • cartopy * development
  • iris * development
  • matplotlib * development
  • nbconvert * development
  • numpy * development
  • pandas * development
  • pre-commit * development
  • pytest * development
  • scikit-image * development
  • scikit-learn * development
  • scipy * development
  • trackpy * development
  • typing_extensions * development
  • xarray * development

Score: 13.846401482245874