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.8b1.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

damagescanner-0.8b1-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for damagescanner-0.8b1.tar.gz
Algorithm Hash digest
SHA256 9b6dee123308970bfbd551748160fb4c20e4a0b8ec7b3efab658cbac8f00a20c
MD5 7057c975e484a4e2deda58ec6bb71abb
BLAKE2b-256 77c1ec6d3816da24ca9b6308f188580c9de948594dece8a2666a323a157d41db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for damagescanner-0.8b1-py3-none-any.whl
Algorithm Hash digest
SHA256 ab52f9626eab6b1d96bfac6ad2302853b079e8d34755c5a1c0ac7586077f151a
MD5 fcbd5e0f026fc815181fb850c695548f
BLAKE2b-256 762316595d7cf2397836b91f9061d6ec9b0d9b0a7a1423a9f1f0e135eb79a423

See more details on using hashes here.

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