Skip to content

Commit e1c7b04

Browse files
committed
docs: improvement to calculations documentation
1 parent c38d878 commit e1c7b04

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

docs/calculations.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ reia risk-assessment run docs/example/job.ini
7777
This command will execute the risk assessment based on the parameters defined in the job configuration file. The results will be stored in the REIA engine and can be accessed or exported as needed.
7878

7979
### Specifying Calculations Separately
80-
Alternatively you can specify the loss and damage calculation separately, or even run ensemble models. You can specify this accordingly in the run command.
80+
Alternatively you can specify the loss and damage calculation separately, or even run ensemble models. You can specify this accordingly in the `run` command.
8181

8282
Separate ini files for loss and damage:
8383

@@ -95,24 +95,7 @@ reia risk-assessment run --config risk.ini --weight 0.3 --config risk2.ini --wei
9595
```
9696

9797
## Hazard Input Options
98-
The simplest way to provide hazard input data is via the `gmfs_csv` and `sites_csv` parameters in the job configuration file as shown above.
99-
100-
```ini
101-
[hazard]
102-
random_seed = 42
103-
truncation_level = 2.0
104-
asset_hazard_distance = 200.0
105-
number_of_ground_motion_fields = 100
106-
intensity_measure_types = PGA,SA(0.1),SA(0.3),SA(0.4)
107-
gmfs_csv = docs/example/gmfs.csv
108-
sites_csv = docs/example/sites.csv
109-
```
110-
111-
The gmfs are already sampled and in the final format as expected by OpenQuake.
112-
113-
### Alternative Hazard Source Options
114-
You can also provide the ground motion fields via different options, as described below. An additional custon section `[hazard_source]` is added to specify the source type. The relevant hazard parameters stay the same:
115-
98+
You can also provide the ground motion fields via different options, as described below. The relevant hazard parameters stay the same:
11699
```ini
117100
[hazard]
118101
random_seed = 568
@@ -125,6 +108,19 @@ minimum_intensity = {"SA(0.3)": 0.10, "SA(0.6)": 0.05}
125108

126109
Where the `intensity_measure_types` and `number_of_ground_motion_fields` are required to specify the used intensity measures and the number of ground motion fields to be generated, or already computed, from the provided hazard source.
127110

111+
An additional custon section `[hazard_source]` is added to specify the source type if an alternative to the CSV format is used as described in the following section.
112+
113+
### OpenQuake CSV format
114+
The simplest way to provide hazard input data is via the `gmfs_csv` and `sites_csv` parameters in the job configuration file as shown above.
115+
116+
```ini
117+
[hazard]
118+
...
119+
gmfs_csv = docs/example/gmfs.csv
120+
sites_csv = docs/example/sites.csv
121+
```
122+
123+
The gmfs are expected to be sampled and in the final format as expected by OpenQuake. No `[hazard_source]` section is required in this case.
128124

129125
### USGS ShakeMap XML format
130126
You can also provide shakemaps in the USGS ShakeMap XML format, in the same manner as the CSV format above:

0 commit comments

Comments
 (0)