tobac

Tracking and object-based analysis of clouds

https://github.com/tobac-project/tobac

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    5 of 16 committers (31.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary

Keywords

cloud tracking
Last synced: 6 months ago · JSON representation

Repository

Tracking and object-based analysis of clouds

Basic Info
  • Host: GitHub
  • Owner: tobac-project
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 105 MB
Statistics
  • Stars: 123
  • Watchers: 8
  • Forks: 60
  • Open Issues: 69
  • Releases: 21
Topics
cloud tracking
Created over 8 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Zenodo

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

  • Name: tobac-project
  • Login: tobac-project
  • Kind: organization

GitHub Events

Total
  • Create event: 11
  • Release event: 4
  • Issues event: 56
  • Watch event: 20
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 191
  • Push event: 55
  • Pull request review event: 48
  • Pull request review comment event: 18
  • Pull request event: 51
  • Fork event: 5
Last Year
  • Create event: 11
  • Release event: 4
  • Issues event: 56
  • Watch event: 20
  • Delete event: 1
  • Member event: 1
  • Issue comment event: 191
  • Push event: 55
  • Pull request review event: 48
  • Pull request review comment event: 18
  • Pull request event: 51
  • Fork event: 5

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 1,444
  • Total Committers: 16
  • Avg Commits per committer: 90.25
  • Development Distribution Score (DDS): 0.699
Past Year
  • Commits: 168
  • Committers: 3
  • Avg Commits per committer: 56.0
  • Development Distribution Score (DDS): 0.357
Top Committers
Name Email Commits
Sean Freeman s****n@u****u 434
William Jones w****s@p****k 319
Max Heikenfeld m****d@w****e 270
Juli j****s@g****e 131
Nils Pfeifer n****r@p****m 88
JuliaKukulies k****s@u****u 45
Kolya Lettl k****l@p****t 35
Fabian Senf s****f@t****e 32
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
Xin Zhang x****5@g****m 1
JuliaKukulies k****s@m****u 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 163
  • Total pull requests: 157
  • Average time to close issues: 6 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 23
  • Total pull request authors: 10
  • Average comments per issue: 2.7
  • Average comments per pull request: 5.24
  • Merged pull requests: 126
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 36
  • Pull requests: 47
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 20 days
  • Issue authors: 8
  • Pull request authors: 5
  • Average comments per issue: 0.97
  • Average comments per pull request: 4.32
  • Merged pull requests: 27
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • freemansw1 (53)
  • w-k-jones (46)
  • JuliaKukulies (20)
  • fsenf (8)
  • wreckdump (6)
  • deeplycloudy (3)
  • snilsn (3)
  • sgupta92 (2)
  • mheikenfeld (2)
  • lettlini (2)
  • zhangzh1118 (2)
  • sortland33 (1)
  • lk337 (1)
  • zxdawn (1)
  • itinderjot (1)
Pull Request Authors
  • w-k-jones (69)
  • freemansw1 (58)
  • JuliaKukulies (27)
  • fsenf (11)
  • lettlini (9)
  • fziegner (5)
  • Sven-248 (4)
  • snilsn (3)
  • MatthewDyerOSU (1)
  • galexsky (1)
Top Labels
Issue Labels
bug (49) enhancement (40) Low Priority (16) documentation (15) question (14) good first issue (12) release (10) to be deleted? (7) dependency (7) xarray transition (6) v2.x compatibility (6) Tobathon (6) discussion (5) workflow (5) In Review (4) Small Change (4) Refactor (3) Tobathon 2025 (3) High Priority (2)
Pull Request Labels
enhancement (50) bug (41) documentation (23) xarray transition (12) release (10) Small Change (10) Refactor (6) High Priority (5) Tobathon 2025 (5) v2.x compatibility (2) Tobathon (2) In Review (1) workflow (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 7
conda-forge.org: tobac

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

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
Rankings
Dependent repos count: 24.4%
Forks count: 27.6%
Average: 35.1%
Stargazers count: 36.9%
Dependent packages count: 51.6%
Last synced: 6 months ago

Dependencies

conda-requirements.txt pypi
  • cartopy *
  • cf-units *
  • iris *
  • matplotlib *
  • numpy *
  • pandas *
  • pre-commit *
  • pytables *
  • scikit-image *
  • scipy *
  • trackpy *
  • xarray *
.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 *