Installation

It is important to make the distinction between the framework (i.e. unifhy) and the science components that the framework can work with (typically named with prefix unifhycontrib-). Indeed, the framework and the science components come as separate packages. Thus, they need to be installed separately.

The framework only provides the infrastructure to combine and run science components. The user must then select and install the science components they want to use to simulate the terrestrial water cycle.

Installing the framework

Official releases

If you wish to install the most recent stable version of unifhy, it is available from the conda-forge channel, so you can use conda (recommended way):

Installing stable version using conda.

$ conda install -c conda-forge unifhy

It is also available from the Python Package Index (PyPI), so you can also use pip:

Installing stable version using pip.

$ pip install unifhy

Warning

Some of the package dependencies cannot be installed using pip (e.g. esmpy). These needs to be installed prior the installation of this package using pip. Please refer to the online documentation of these packages to follow the recommended way of installing them. The full list of package dependencies can be found in the requirements.txt file of the given release.

Latest developments

If you need the latest, potentially unstable, features listed in the change log, please install from the dev branch on the GitHub repository:

Installing latest features using pip.

$ pip install git+https://github.com/unifhy-org/unifhy.git@dev

Testing the framework

To check whether the framework has been installed properly, you can run tests. These tests are available from the tests directory in the repository:

Running the basic test suite.

$ python run_basic_tests.py

Installing science components

The science components listed in the science library are independent of the framework: they come as Python packages of their own. Consequently, they need to be installed separately. The distribution of these components is left at the discretion of the component contributors. Please refer to their documentation and/or their codebase to follow the recommended way of installing them.