Skip to content

TTU's work with tobac for the TRACER/ESCAPE field campaigns

License

Notifications You must be signed in to change notification settings

kelcyno/TTU_tobac

Repository files navigation

tobac - Tracking and Object-based Analysis of Clouds

Documentation StatusBuild Status

What is it?

tobac is a Python package for identifiying, tracking and analysing of clouds in different types of gridded datasets, i.e. 3D model output from cloud resolving model simulations or 2D data of satellite observations.

Documentation

Individual features are indentified 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.

Installation

tobac now works for both Python 3 and Python 2 installations.

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 conda-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/climate-processes/tobac.git
pip install --upgrade git+https://github.com/climate-processes/tobac.git

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

git clone git@github.com:climate-processes/tobac.git
git clone https://github.com/climate-processes/tobac.git

and install the package from the locally cloned version:

pip install tobac/

Contributing

The current development branch for minor updates to tobac v1 is dev.

Preliminary development of the future major update to tobac is v2.0-dev.

For more details on contributing, please see https://github.com/climate-processes/tobac/blob/v2.0-dev/CONTRIBUTING.md

Roadmap

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

About

TTU's work with tobac for the TRACER/ESCAPE field campaigns

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published