Skip to content

Commit

Permalink
Prepare for release of version 1.2 including changes to setup.py and …
Browse files Browse the repository at this point in the history
…some additions to the documentation (#30)

 Prepare for release of version 1.2 including changes to setup.py and some additions to the documentation
  • Loading branch information
mheikenfeld authored Sep 14, 2019
1 parent 1cfc95c commit eb4b2ba
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ 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.
Expand Down
Binary file added doc/images/Figure_linking.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@ Installation
------------
tobac is now capable of working with both Python 2 and Python 3 (tested for 2.7,3.6 and 3.7) 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 pip, which is mainly interesting for development purposed or to use specific development branches for the Github repository.

The follwoing python packages are required (including dependencies of these packages):

*trackpy*, *scipy*, *numpy*, *iris*, *scikit-learn*, *scikit-image*, *cartopy*, *pandas*, *pytables*
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from setuptools import setup

setup(name='tobac',
version='1.1.1',
version='1.2',
description='Tracking and object-based analysis of clouds',
url='http://github.com/climate-processes/tobac',
author='Max Heikenfeld',
Expand Down

0 comments on commit eb4b2ba

Please sign in to comment.