damagescanner 0.9b4

Direct damage assessments for natural hazards

DamageScanner: direct damage assessments for natural hazards

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

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

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:

• Koks. E.E. (2022). DamageScanner: Python tool for natural hazard damage assessments. Zenodo. http://doi.org/10.5281/zenodo.2551015

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.