Skip to content

Removed docs about the obsolete format for the consequence files #10275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
micheles merged 2 commits into from
Jan 21, 2025
Merged

Removed docs about the obsolete format for the consequence files #10275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98a27eb
Removed docs about the obsolete format for the consequence files
micheles Jan 21, 2025
0be863d
Fixed indentation
micheles Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/user-guide/configuration-file/event-based-risk-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ event based damage calculation is shown in the listing below.::
structural_fragility_file = structural_fragility_model.xml

[consequence]
structural_consequence_file = structural_consequence_model.xml
consequence_file = {'taxonomy': "consequence_model.csv"}

[risk_calculation]
master_seed = 42
Expand Down
29 changes: 15 additions & 14 deletions doc/user-guide/configuration-file/scenario-risk-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,20 +346,21 @@ is shown in the listing below.::
nonstructural_fragility_file = nonstructural_fragility_model.xml

[consequence]
structural_consequence_file = structural_consequence_model.xml
nonstructural_consequence_file = nonstructural_consequence_model.xml

Note that one or more of the following parameters can be used in the same job configuration file to provide the
corresponding *Consequence Model* files:

- ``structural_consequence_file``: a parameter used to define the path to a structural Consequence Model file
- ``nonstructural_consequence_file``: a parameter used to define the path to a nonstructural Consequence Model file
- ``contents_consequence_file``: a parameter used to define the path to a contents Consequence Model file
- ``business_interruption_consequence_file``: a parameter used to define the path to a business interruption Consequence Model file

It is important that the ``lossCategory`` parameter in the metadata section for each provided Consequence Model file
(“structural”, “nonstructural”, “contents”, or “business_interruption”) should match the loss type defined in the
configuration file by the relevant keyword above.
consequence_file = {'taxonomy': "consequence_model.csv"}

Note that the "consequence_model.csv" file will have a structure like the
following::

taxonomy,consequence,loss_type,ds1,ds2,ds3,ds4
tax1,losses,contents,1.000000E-01,3.000000E-01,6.000000E-01,9.000000E-01
tax2,losses,contents,1.000000E-01,3.000000E-01,6.000000E-01,9.000000E-01
tax3,losses,contents,1.000000E-01,3.000000E-01,6.000000E-01,9.000000E-01
tax1,losses,nonstructural,5.000000E-02,2.500000E-01,5.000000E-01,7.500000E-01
tax2,losses,nonstructural,5.000000E-02,2.500000E-01,5.000000E-01,7.500000E-01
tax3,losses,nonstructural,5.000000E-02,2.500000E-01,5.000000E-01,7.500000E-01
tax1,losses,structural,4.000000E-02,1.600000E-01,3.200000E-01,6.400000E-01
tax2,losses,structural,4.000000E-02,1.600000E-01,3.200000E-01,6.400000E-01
tax3,losses,structural,4.000000E-02,1.600000E-01,3.200000E-01,6.400000E-01

The above calculation can be run using the command line::

Expand Down