Skip to main content

Direct damage assessments for natural hazards

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

damagescanner-1.0.1.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

damagescanner-1.0.1-py3-none-any.whl (33.3 kB view details)

Uploaded Python 3

File details

Details for the file damagescanner-1.0.1.tar.gz.

File metadata

  • Download URL: damagescanner-1.0.1.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for damagescanner-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2686e1ba923b2a02c76b82c7c0ed9d3d10686b4dcbe64aeb0d6d0864bc51e406
MD5 8e09998ac83fb3df891a6c15587b4a8b
BLAKE2b-256 6b9a531ff8bc2916df8e6eda22b0d68e941f773ba597a912b476f404e4bc6a7c

See more details on using hashes here.

Provenance

The following attestation bundles were made for damagescanner-1.0.1.tar.gz:

Publisher: publish.yml on VU-IVM/DamageScanner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file damagescanner-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: damagescanner-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 33.3 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for damagescanner-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f77aadf5166c7fe4759b59fa0ff097ac85b2aaa21eee52107db60bf9590bc020
MD5 084576b6f867192ee7f68dca29e27520
BLAKE2b-256 511343d6b3204d18e5d8b852d2d39c18d14409ff5d16dd11dff1b917f92968bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for damagescanner-1.0.1-py3-none-any.whl:

Publisher: publish.yml on VU-IVM/DamageScanner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page