Deltares / Koswat

KOSWAT, from the Dutch combination of words KOSten van WATerkeringen (costs of dike reinforcements). Development version!! For the official software click: https://iplo.nl/thema/water/applicaties-modellen/waterveiligheidsmodellen/koswat/
https://deltares.github.io/Koswat/
Other
0 stars 0 forks source link

KOSWAT

Python 3.10 Code style: black TeamCity build status Quality Gate Status GitHub release (latest by date) GitHub tag (latest by date)

Detailed documentation

Currently the detailed documentation is only reachable when building it locally, to do so check the section read the docs documentation.

Features

Intended audience

Koswat targets two types of users:

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.

Sandbox / Endpoint

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:

  1. Latest available Master:

    pip install git+https://github.com/Deltares/Koswat.git
  2. Specific Koswat version, add @version-tag to the previous command, for instance install tag v0.11.0 (MVP pre-release):

    pip install git+https://github.com/Deltares/Koswat.git@v0.11.0

    | You can also do the above with a commit-hash for development branches (e.g.:@0504c06)

Development mode

  1. 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:

    cd C:\repos
    git clone https://github.com/Deltares/Koswat.git koswat

    | Note, the above steps are based on a Windows setup. If you are not familiar with Git we recommend using the GitHub desktop tool.

  2. Navigate to your Koswat repository and then install the koswat package with your preferred step:

    1. With Anaconda (miniforge) (our recommendation):
      cd C:\repos\koswat
      conda env create -f .config\environment.yml
      conda activate koswat_env
      poetry install
    2. With pypi:
      cd C:\repos\koswat
      pip install .

      | Note, this will not install Poetry, which is required to properly maintain the interdependencies of Koswat tool.

Read the docs documentation.

Documentation for the project is currently only available with a manual step. You can do this if you installed the project following the steps of the development mode. Then execute the MkDocs build and serve step:

poetry run mkdocs build
poetry run mkdocs serve

Endpoint usage

When using Koswat as a package you can run it directly from the command line as follows:

python -m koswat --input_file path\\to\\your\\koswat.ini --log_output path\\to\\your\\output\\dir

The arguments are:

It is also possible to check all the above possibilities via the --help argument in the command line:

python -m koswat --help