Getting the envtoolkit library

Module requierements

The envtoolkit library requieres the following packages:

Downloading the source

The envtoolkit library is available via the Sourcesup platform. It can be downladed by using Subversion as follows:

> mkdir envtoolkit
> cd envtoolkit
> svn checkout https://subversion.renater.fr/envtoolkit/trunk

The last version of the library is obtained as follows:

> cd envtoolkit
> svn update

Module installation

The module installation is achieved as follows:

> cd trunk
> python setup.py install --home=/install/directory

The home option indicates the location where the library will be installed. Note that the install directory must be in the PYTHONPATH. If it is not the case, you should edit your .bashrc file and add the following line:

export PYTHONPATH=$PYTHONPATH:/install/directory/lib/python  # for BASH/KSH
setenv PYTHONPATH ${PYTHONPATH}:/install/directory/lib/python # for CSH/TCSH

Generating the documentation

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

> cd trunk/docs
> make html
> make latexpdf

Note that the environment variable SPHINXBUILD, containing the name of the Sphinx executable file, must be defined.

export SPHINXBUILD=sphinx-build-2.7  # for BASH/KSH
setenv SPHINXBUILD sphinx-build-2.7  # for CSH/TCSH

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

Note

An HTML version of this documentation is available here (see the Python/NCL tab).