Installation Guide#
HydroMT-SFINCS is available on PyPI and conda-forge. If you want to use HydroMT-SFINCS to build your own model, you can install it using the following steps.
Prerequisite: python installation#
You’ll need Python 3.11 or greater and a package manager such as conda, mamba or others in order to use HydroMT-SFINCS. These package managers help you to install (Python) packages and manage environments such that different installations do not conflict.
If you do not yet have such a package manager, we recommend using either:
Miniforge: uses the mamba package manager
Miniconda: uses the conda package manager
Note
We recommend using the mamba package manager. However, in the commands below you can exchange mamba for conda.
If you already have a python & conda installation but do not yet have mamba installed, you can install it into your base environment using:
$ conda install mamba -n base -c conda-forge
Installation#
HydroMT-SFINCS is available from pypi and conda-forge. We recommend installing from conda-forge in a new conda environment.
Install HydroMT-SFINCS in a new environment (recommended!)#
You can install HydroMT-SFINCS in a new environment called hydromt-sfincs together with a few additional dependencies which are required for the HydroMT-SFINCS examples. To do so, create a new environment from the environment.yml file in the repository root with the following command:
$ mamba env create -f https://raw.githubusercontent.com/Deltares/hydromt_sfincs/main/environment.yml
Then, activate the environment (as stated by mamba/conda) to start making use of HydroMT-SFINCS:
conda activate hydromt-sfincs
Tip
If you already have an environment with this name, either remove it with conda env remove -n hydromt-sfincs or set a new name for the environment by adding -n <name> to the line above.
Note
The environment yaml-files in envs folder are meant for testing and development, so please use the environment.yml file in the repository root for normal usage. In case you want to develop, see the Developer installation guide.
Install HydroMT-SFINCS in an existing environment#
To install HydroMT-SFINCS in an existing environment execute the command below where you replace <environment_name> with the name of the existing environment. Note that if some dependencies are not installed from conda-forge but from pip or other channels the installation may fail.
$ mamba install -c conda-forge hydromt_sfincs -n <environment_name>
Developer install#
To be able to test and develop the HydroMT-SFINCS package see instructions in the Developer installation guide.