Commit 58178ad0 authored by Tara Evaz Zadeh's avatar Tara Evaz Zadeh
Browse files

Merge branch 'feature/readme' into 'master'

Improved README.md

See merge request !18
parents ae9cdff3 eaf87759
Pipeline #17656 passed with stage
in 40 seconds
# losscalculator
This program computes damage-state probabilities for scenario earthquakes, given a
ground-motion field, an exposure model representing the assets in the region of interest and
fragility functions that model the probability of exceeding different damage states given an
intensity measure level.
This program computes the probabilities of occurrence of damage states for scenario
earthquakes, given a ground-motion field, an exposure model representing the assets in the
region of interest and fragility functions that model the probability of exceeding different damage states given an intensity measure level.
## Requirements
* `python3`
* `pandas`
* `numpy`
* `scipy`
## Usage
To run the program please call:
`python3 damage_calculator.py [OPTIONS] -c filepath -e filepath -f pathname -g filepath -p filepath -t filepath`
### Required Parameters
`-c`, `--cellIdSource-filepath=filepath`
Defines the filepath to the file with tile IDs.
`-e`, `--exposure-filepath=filepath`
Defines the filepath to the exposure model file.
`-f`, `--fragility-pathname=pathname`
Defines the pathname of the directory with all fragility-function files.
`-g`, `--shakemap-filepath=filepath`
Defines the filepath of the ground-motion field.
`-p`, `--polygonSource-filepath=filepath`
Defines the filepath of the polygon definitions.
`-t`, `--taxonomy-conversion-filepath=filepath`
Defines the filepath to the taxonomy file.
### Optional Parameters
`-h`, `--help`
Provides information on the inputs and terminates the program.
`-m`, `--interpolation-method={linear, nearest, cubic}`
Defines the method for interpolating ground-motion values. Default is `linear`.
`-o`, `--overwrite`
If set, an existing result file will be overwritten, otherwise the program will terminate.
`-r`, `--result-filepath=filepath`
Defines the result filepath. Default is `damage_result.csv`.
`-x`, `--exposure-type={cell, building}`
Defines the exposure type. Default is `cell`.
## Copyright and copyleft
......@@ -35,3 +96,4 @@ solutions will be better for different programs; see section 13 for the
specific requirements.
See the [LICENSE](./LICENSE) for the full license text.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment