Skip to content

Commit

Permalink
updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Charlie-Farrar committed Aug 4, 2023
1 parent 02098af commit f940edd
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions src/sections/ODS-tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ ODS Tools is a Python package designed to manage :doc:`../../sections/ODS` data,
:doc:`ODS <../../sections/ODS>` schema. It includes a range of tools for working with Oasis data files, including loading,
conversion, and validation. This package is in accordance with :doc:`ODS <../../sections/ODS>`.

As a separate service, the package include functionality to manage :doc:`../../sections/model-settings` and
:doc:`../../sections/analysis-settings` that are used to perform an analysis.
As a separate service, the package include functionality to manage :doc:`../../sections/model_settings` and
:doc:`../../sections/analysis_settings` that are used to perform an analysis.

ODS tools comprises primarily of two parts:

Expand Down
4 changes: 3 additions & 1 deletion src/sections/Oasis-models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ give rise to inflated and/or deflated costs depending on that specific situation
losses produced by the GUL calculation component are multiplied by post loss amplification factors, by the component
plapy.

----

PiWind Single Peril
*******************

Expand All @@ -102,7 +104,7 @@ PiWind - toy model
Oasis has developed a toy model, PiWind, available `here <https://github.com/OasisLMF/OasisPiWind>`_. PiWind is a wind storm
model for a small area of the UK. The data is mocked up to illustrate the Oasis data formats and functionality, and is not
meant to be a usable risk model. The PiWind toy model is availible to use from `here <https://github.com/OasisLMF/
OasisModels/tree/develop/PiWind>`.
OasisModels/tree/develop/PiWind>`_.

There are three main components to a catastrophe risk model deployed in Oasis. A fuller discussion of the components of a
hazard model can be found in :doc:`modelling-methodology`.
Expand Down
2 changes: 1 addition & 1 deletion src/sections/post-loss-amplification.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ gulpy or gulmc...or complex model wrapper implementations. However, if elements
improve performance, this is also an option.

An example toy model with post loss amplification is availible to use from `here <https://github.com/OasisLMF/
OasisModels/tree/develop/PiWindPostLossAmplification>`.
OasisModels/tree/develop/PiWindPostLossAmplification>`_.

|
Expand Down
1 change: 0 additions & 1 deletion src/sections/versioning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,5 @@ This page lists what features were released with each verion.
* The Group ids can now be set by the following internal oasis fields 'item_id', 'peril_id', 'coverage_id', and
'coverage_type_id'
* Added validation for unsupported special conditions
*

|

0 comments on commit f940edd

Please sign in to comment.