Table Of Contents

Previous topic

Introduction

Next topic

Implementation

This Page

Installing

Dependencies

Requirements

In order to use the scikits.hydroclimpy package, the following external packages must be installed beforehand:

Python 2.5 or later.
Please note that Python 3 is not supported yet.
setuptools
scikits is a namespace package, and as a result every scikit requires setuptools to be installed to function properly.
Numpy 1.3.0 or later.
Numpy is a library to manipulate large arrays of numerical data.
scikits.timeseries_
The timeseries scikits is an extension to Numpy designed to manipulate series indexed in time.
SciPy 0.7.0 or later:
SciPy is a set of Numpy-based tools for engineering and scientific applications. Some of the sub-modules of scikits.timeseries_ use SciPy interpolation and signal functions.

Optional

BeautifulSoup :
BeautifulSoup is a HTML/XML parser designed to quickly load information stored in a parse tree. It is used by the scikits.hydroclimpy.enso module to retrieve information about the Oceanic Niño index.
xlrd :
xlrd is a package to extract information from Microsoft Excel spreadsheets. This package is used by the scikits.hydroclimpy.io.coaps module to retrieve information about the stations of the COAPS network.

Download

The scikits.hydroclimpy module itself is currently available through subversion only. You can download the latest version of the source files by checking out the repository with the command:

svn co http://svn.scipy.org/svn/scikits/trunk/hydroclimpy hydroclimpy

This command will create a hydroclimpy folder in the current directory. On Windows, you can also use a SVN client such as Tortoise SVN.

Installation

To install the scikits.hydroclimpy package, run the command:

python setup.py install

in the directory you checked out the source code to.

If you run Python 2.6, note that you should probably use the --user or --home flags to install the package locally, without interfering with the system installation.

Configuration

The package requires a configuration file ('hydroclimpyrc') to be imported. An example of configuration file (hydroclimpyrc) is provided with the sources and is copied in the installation directory. This file should be modified by the user according to his/her needs.

When the package is imported, the file is looked for successively in the following locations successively:

  • the current working directory
  • the directory reprensented by the environment variable HYDROCLIMPYRC
  • the $HOME/.hydroclimpy directory
  • the $PYTHONPATH/hydroclimpy directory

Information

About

History

The scikits.hydroclimpy module was originally developed by Pierre Gérard-Marchant to analyze the influence of climate variations (ENSO) on streamflows in the Southeastern US.

Part of the initial code related to the manipulation of series with missing data. This code was eventually incorporated in numpy as the numpy.ma module. Another part of the code was related to the handling of series indexed in time, and was merged with the scikits.timeseries code.

Thanks

Code development was sponsored by the Southeast Climate Consortium and the University of Georgia.

License

Overview

The scikits.hydroclimpy scikit is free for both commercial and under the BSD license.

Support

No commercial support is offered for the scikits.hydroclimpy module. Requests for help should be directed to Pierre Gérard-Marchant