diff --git a/README.md b/README.md index 28859e5a..e7867a43 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/doc/images/Figure_linking.png b/doc/images/Figure_linking.png new file mode 100644 index 00000000..12048079 Binary files /dev/null and b/doc/images/Figure_linking.png differ diff --git a/doc/installation.rst b/doc/installation.rst index f00c51db..f8895e4a 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -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* diff --git a/setup.py b/setup.py index 5956c6e4..5f9cd927 100644 --- a/setup.py +++ b/setup.py @@ -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',