Getting the envtoolkit library¶

Module requierements¶

The envtoolkit library requieres the following packages:

numpy (for maths)
matplotlib.pyplot (for plots)
matplotlib.colors (for colors)
matplotlib.path (for polygons)
netCDF4 (http://unidata.github.io/netcdf4-python/)
spectrum (http://pythonhosted.org/spectrum/)

Downloading the source¶

The envtoolkit library is available on a GitHub repository. It can be downladed by using Git as follows:

> git clone https://github.com/barriern/Environmental-toolkit

The last version of the library is obtained as follows:

> cd Environmental-toolkit
> git pull

Module installation¶

The module installation is achieved as follows:

> cd trunk
> python setup.py install

Generating the documentation¶

The envtoolkit documentation can be built offline by using the Sphinx library. This is achieved as follows:

> cd docs
> make html
> make latexpdf

The HTML documentation is built in the docs/build/html directory (index.html file), while the LaTex documentation is built in the docs/build/latex directory (envtoolkit.pdf file).