Skip to main content

Direct damage assessments for natural hazards

Project description

DamageScanner: direct damage assessments for natural hazards

Logo

github repo badge github license badge fair-software badge Documentation Status PyPI version DOI 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

workflow pypi badge

Requirements: NumPy, pandas, geopandas, matplotlib, rasterio, tqdm, xarray, pyproj

  1. Open the python environment in your command prompt or bash in which you want to install this package.
  2. Type pip install damagescanner and it should install itself into your python environment.
  3. Now you can import the package like any other package!

OR:

  1. Clone the repository or download the package on your computer and extract the folder.
  2. Go to the DamageScanner folder in your command prompt or bash.
  3. Type python setup.py install and it should install itself into your python environment.
  4. Now you can import the package like any other package!

Create testing environment

Recommended option is to use a miniconda environment to work in for this project, relying on conda to handle some of the trickier library dependencies.

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

# Create a conda environment for the project and install packages
conda env create -f environment.yml
activate ds_env

Documentation

Documentation Status

Please refer to the ReadTheDocs 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.},
          title        = {DamageScanner: Python tool for natural hazard damage assessments},
          year         = 2022,
          doi          = {10.5281/zenodo.2551015},
          url          = {http://doi.org/10.5281/zenodo.2551015}
    }

License

Copyright (C) 2022 Elco Koks. 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-0.9b1.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

damagescanner-0.9b1-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

Details for the file damagescanner-0.9b1.tar.gz.

File metadata

  • Download URL: damagescanner-0.9b1.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for damagescanner-0.9b1.tar.gz
Algorithm Hash digest
SHA256 73b94e5afe567704b5160d6f41ea39f729b8bb313b5e13eae77dbd3d4b7af5c3
MD5 016a9a323cd90c78a97c333c70b2d6ae
BLAKE2b-256 d4b0c61824bb50e2a204c31ebd08df8607fbd34bc1773c4c1e4fa4172da5031f

See more details on using hashes here.

Provenance

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

Publisher: release.yml on VU-IVM/DamageScanner

Attestations:

File details

Details for the file damagescanner-0.9b1-py3-none-any.whl.

File metadata

File hashes

Hashes for damagescanner-0.9b1-py3-none-any.whl
Algorithm Hash digest
SHA256 5ee379604461039e0cbd72976c7d4ceaca10b8538ce03ce2c8bd23908979c076
MD5 9805b0552feb8b70e1fac19e56b8e949
BLAKE2b-256 c141f74affa144b8c6d2a49a6e182daf674b595fbe03181a67ce6b58576238ac

See more details on using hashes here.

Provenance

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

Publisher: release.yml on VU-IVM/DamageScanner

Attestations:

Supported by

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