Installation¶
Important! : The following installation steps are written based on a Windows environment. When using other systems (which should be possible) it might be required to use different commands. However, the fundamental of the installation steps should remain the same. This meaning, no additional packages or libraries should be required. If problems would arose during your installation, please contact the maintainers of the tool.
For users¶
When you only require the koswat package to be used as a whole, and not for developments, we advise to directly use the latest greatest release, or directly the latest available version from Master
as follows:
-
Latest available
Master
:pip install git+https://github.com/Deltares/Koswat.git
-
Specific Koswat version, add
@version-tag
to the previous command, for instance install tagv0.11.0
(MVP pre-release):| You can also do the above with a commit-hash for development branches (e.g.:pip install git+https://github.com/Deltares/Koswat.git@v0.11.0
@0504c06
) -
Using docker (requires checking the repository in a directory):
cd <your koswat checked out directory> docker build -t koswat:latest -f Dockerimage . docker run -it koswat bash
For developers¶
-
Checkout the code from github in a directory of your choice. You can either do this by downloading the source zip or (better) using git, for instance:
| Note, the above steps are based on a Windows setup. If you are not familiar with Git we recommend using the GitHub desktop tool.cd C:\repos git clone https://github.com/Deltares/Koswat.git koswat
-
Navigate to your Koswat repository and then install the koswat package with your preferred step:
- With Miniforge (our recommendation):
cd C:\repos\koswat conda env create -f .config\environment.yml conda activate koswat_env poetry install
- With
pypi
:| Note, this will not installcd C:\repos\koswat pip install .
Poetry
, which is required to properly maintain the interdependencies ofKoswat
tool.
- With Miniforge (our recommendation):