Skip to main content

DamageScanner: direct damage assessments for natural hazards

Logo

fair-software badge github license badge Tests DOI Documentation PyPI version PyPI - Downloads

A python toolkit for direct damage assessments for natural hazards. Even though the method is initially developed for flood damage assessments, it can calculate damages for any hazard for which you just require a vulnerability curve (i.e. a one-dimensional relation).

Please note: This package is still in development phase. In case of any problems, or if you have any suggestions for improvements, please raise an issue.

Background

This package is (loosely) based on the original DamageScanner, which calculated potential flood damages based on inundation depth and land use using depth-damage curves in the Netherlands. The DamageScanner was originally developed for the 'Netherlands Later' project (Klijn et al., 2007). The original land-use classes were based on the Land-Use Scanner in order to evaluate the effect of future land-use change on flood damages.

Installation

To use DamageScanner in your project:

Using uv (recommended)

uv add damagescanner

Using pip

pip install damagescanner

Development & Testing

To set up a local environment for development or to run tests:

Using uv (recommended)

uv is an extremely fast Python package manager and is the preferred way to set up the development environment.

# Clone the repository
git clone https://github.com/VU-IVM/DamageScanner.git
cd DamageScanner

# Create a virtual environment and install all optional dependencies
uv sync --all-groups

Using Miniconda

If you prefer Miniconda, use the provided environment.yml file:

# Add conda-forge channel for extra packages
conda config --add channels conda-forge

# Create environment and activate
conda env create -f environment.yml
conda activate ds-test

Documentation

Please refer to the documentation of this project for the full documentation of all functions.

How to cite

If you use the DamageScanner in your work, please cite the package directly:

Here's an example BibTeX entry:

@misc{damagescannerPython,
      author       = {Koks, E.E. and {de Bruijn}, J.},
      title        = {DamageScanner: Python tool for natural hazard damage assessments},
      year         = 2026,
      doi          = {10.5281/zenodo.2551015},
      url          = {http://doi.org/10.5281/zenodo.2551015}
}

License

Copyright (C) 2026 Elco Koks & Jens de Bruijn. All versions released under the MIT license.

Release files for damagescanner 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for damagescanner 1.0.1
File Size Uploaded
damagescanner-1.0.1.tar.gz 30.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for damagescanner 1.0.1
File Interpreter ABI Platform
damagescanner-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 63.9 kB

Release files / damagescanner-1.0.1.tar.gz

Download URL damagescanner-1.0.1.tar.gz
Size 30.6 kB
Tags Source
SHA-256 checksum
How to use checksums
2686e1ba923b2a02c76b82c7c0ed9d3d10686b4dcbe64aeb0d6d0864bc51e406
BLAKE2b-256 checksum
How to use checksums
6b9a531ff8bc2916df8e6eda22b0d68e941f773ba597a912b476f404e4bc6a7c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.10.8 {"installer":{"name":"uv","version":"0.10.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 4, 2026.

Transparency log

Release files / damagescanner-1.0.1-py3-none-any.whl

Download URL damagescanner-1.0.1-py3-none-any.whl
Size 33.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f77aadf5166c7fe4759b59fa0ff097ac85b2aaa21eee52107db60bf9590bc020
BLAKE2b-256 checksum
How to use checksums
511343d6b3204d18e5d8b852d2d39c18d14409ff5d16dd11dff1b917f92968bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.10.8 {"installer":{"name":"uv","version":"0.10.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 4, 2026.

Transparency log

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page