Developer’s environment

If you want to download the SFINCS plugin directly from git to easily have access to the latest developments or make changes to the code you can use the following steps.

First, clone the HydroMT SFINCS plugin git repo from github, then navigate into the the code folder (where the envs folder and pyproject.toml are located):

$ git clone https://github.com/Deltares/hydromt_sfincs.git
$ cd hydromt_sfincs

Then, make and activate a new hydromt-sfincs conda environment based on the envs/hydromt-sfincs.yml file contained in the repository:

$ conda env create -f envs/hydromt-sfincs-dev.yml
$ conda activate hydromt-sfincs

Finally, to make changes in hydromt_sfincs, you should make an editable install of HydroMT.

$ pip install -e .

Note

The -e flag makes the install editable, meaning that any changes you make to the code will be immediately available in the environment.

The . at the end of the command tells pip to install the package in the current directory. If you are not yet in the directory of hydromt_sfincs, you can specify your local path to the package instead.