Metadata-Version: 2.4
Name: koswat
Version: 0.16.2
Summary: Koswat, from the dutch combination of words `Kosts-Wat` (what are the costs). Analyzes all the possible dikes reinforcements based on a provided traject, with surrounding constructions, and what their related costs will be.
Project-URL: homepage, https://github.com/Deltares/koswat
Project-URL: documentation, https://deltares.github.io/Koswat/
Project-URL: repository, https://github.com/Deltares/koswat
Project-URL: issues, https://github.com/Deltares/koswat/issues
Author-email: Peter de Grave <peter.degrave@deltares.nl>
Maintainer-email: "Carles S. Soriano Pérez" <carles.sorianoperez@deltares.nl>, Ardt Klapwijk <ardt.klapwijk@deltares.nl>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Keywords: civil-engineering,deltares,dikes,flood-defence
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Hydrology
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <3.15,>=3.11
Requires-Dist: click
Requires-Dist: geopandas
Requires-Dist: matplotlib
Requires-Dist: more-itertools
Requires-Dist: pyshp
Requires-Dist: shapely
Description-Content-Type: text/markdown

# KOSWAT

[![Python 3.11](https://img.shields.io/badge/Python-3.11-blue.svg)](https://www.python.org/downloads/release/python-31110/)
[![Python 3.12](https://img.shields.io/badge/Python-3.12-blue.svg)](https://www.python.org/downloads/release/python-31212/)
[![Python 3.13](https://img.shields.io/badge/Python-3.13-blue.svg)](https://www.python.org/downloads/release/python-31311/)
[![Python 3.14](https://img.shields.io/badge/Python-3.14-blue.svg)](https://www.python.org/downloads/release/python-3143/)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![ci-install-package](https://github.com/Deltares/Koswat/actions/workflows/ci_installation.yml/badge.svg)](https://github.com/Deltares/Koswat/actions/workflows/ci_installation.yml)
![TeamCity build status](https://dpcbuild.deltares.nl/app/rest/builds/buildType:id:Koswat_ContinuousIntegrationBuild_RunFastTests/statusIcon.svg)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Deltares_Koswat&metric=alert_status&token=87fdd0648c19800b4b5fc11334461a7fb602bf20)](https://sonarcloud.io/summary/new_code?id=Deltares_Koswat)
[![GitHub Pages documentation](https://github.com/Deltares/koswat/actions/workflows/deploy_docs.yml/badge.svg)](https://github.com/Deltares/koswat/actions/workflows/deploy_docs.yml)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Deltares/koswat/jupyter-binder)
<!-- ![GitHub release (latest by date)](https://img.shields.io/github/v/release/Deltares/Koswat)
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/Deltares/Koswat) -->
<!-- [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Deltares/Koswat?quickstart=1) -->

Quick documentation reference:
- [Contributing wiki page](https://github.com/Deltares/Koswat/wiki/Contributing)
- [Installation](https://deltares.github.io/Koswat/installation.html)
- [User manual](https://deltares.github.io/Koswat/user_manual.html)
    - [Examples](https://deltares.github.io/Koswat/examples.html)
- [Docker](https://deltares.github.io/Koswat/docker.html)

## Features

- Dike profile generation based on data from the koswat `json` file.
- Calculation of all possible reinforcement profiles.
- Filtering of reinforcement profiles based on their surroundings.
- Cost calculation for added and removed material per layer per reinforcement.
- Plotting of reinforcements and layer cross section.
- Export of results to `csv`.
- Logging of analysis.

## Intended audience
Koswat targets two types of users:
- Sandbox users. This target group are users acquianted with `Python` scripting. For them we envision two main interests when using the tool as a sandbox:
    - Extending its functionality, or _correcting_ the existing one via pull-requests. This requires them to adhere to our __Development Guidelines__ (not yet present) and to use the Koswat repository in [Development mode](#development-mode).
    - Creating their own scripts. It is possible to use the full extent of Koswat features on custom scripts, of course under your own responsibility. In this case the user only requires to install the most convinient version of the package as a [sandbox / endpoint](https://deltares.github.io/Koswat/user_manual.html#as-a-sandbox).
- Single endpoint users. These users are only interested in running the tool via command line or other User Interfaces. For them, it is advised to install the tool as a [sandbox / endpoint](https://deltares.github.io/Koswat/user_manual.html#as-a-sandbox) and to check the tool's [endpoint usage](https://deltares.github.io/Koswat/user_manual.html#as-a-command-line-tool).
