Skip to content
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.

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

Feature/update docs update formatting #18

Merged
merged 27 commits into from
Oct 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
9686b12
logo fix
Charlie-Farrar Aug 1, 2023
5439a1c
updating documentation
Charlie-Farrar Aug 1, 2023
afd46bf
update versioning for LTS only
Charlie-Farrar Aug 1, 2023
6011c0e
updates methodologies
johcarter Aug 2, 2023
9085225
fix hyperlink
Charlie-Farrar Aug 3, 2023
7c32067
add Sampling Methodology to index
Charlie-Farrar Aug 3, 2023
e8dae01
sampling method update
johcarter Aug 3, 2023
0a402c7
add toy model link for PLA
Charlie-Farrar Aug 3, 2023
02098af
updating models
Charlie-Farrar Aug 4, 2023
f940edd
updating documentation
Charlie-Farrar Aug 4, 2023
5ac1ed7
analysis settings schema link fix
Charlie-Farrar Aug 4, 2023
4715384
Oasis Model section - absolute damage description added
Charlie-Farrar Aug 4, 2023
a978ed0
add absolute damage section placeholder
Charlie-Farrar Aug 4, 2023
9b4259d
update documatation for model links
Charlie-Farrar Aug 4, 2023
17c93e3
update OasisLMF package section
Charlie-Farrar Aug 8, 2023
fc63098
update ODS_tools section
Charlie-Farrar Aug 8, 2023
1c6c2b5
add pre-analysis geocode section
Charlie-Farrar Aug 11, 2023
6515ec4
add geocoding section
Charlie-Farrar Aug 11, 2023
a604b55
update geocoding model link
Charlie-Farrar Aug 14, 2023
d3fd109
update Oasis Ecosystem image
Charlie-Farrar Aug 14, 2023
65abff8
add gulpy documentation to pytools section
Charlie-Farrar Aug 14, 2023
37d3e57
Fix Oasis Eval
sambles Aug 14, 2023
13d030e
Merge pull request #19 from OasisLMF/update-platform-docs
Charlie-Farrar Aug 15, 2023
4127abf
update Oasis Evaluation description
Charlie-Farrar Aug 15, 2023
f680b96
correlation updates
johcarter Aug 17, 2023
65232b0
update ecosystem figure
Charlie-Farrar Aug 21, 2023
ecb6894
add gulmc documentation to pytools section
Charlie-Farrar Aug 31, 2023
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 redoc/analysis_settings/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

The run time settings for the analysis are controlled by the `analysis_settings.json` file which is a user supplied file detailing all of the options requested for the run (model to run, exposure set to use, number of samples, occurrence options, outputs required, etc.). In the MDK, the analysis settings file must be specified as part of the command line arguments (or in the oasislmf.json configuration file) and in the platform, it needs to be posted to the endpoint. A full json schema for the available options in the analysis settings file can be found here:

https://github.com/OasisLMF/ODS_Tools/blob/develop/ods_tools/data/analysis_settings_schema.json
https://github.com/OasisLMF/ODS_Tools/blob/main/ods_tools/data/analysis_settings_schema.json

This is useful for more technical users who are looking to create their own UI or integrate Oasis with an existing system. The `analysis_settings` schema hierarchy is shown in `json` format in right column of the page. An interactive version of the schema, with descriptions and examples, can be found below:
2 changes: 1 addition & 1 deletion redoc/analysis_settings/redoc_template.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"description": "<TEXT HERE>",
"version": "<ODS_VERSION>",
"x-logo": {
"url": "https://oasislmf.github.io/_static/OASIS_LMF_COLOUR.png",
"url": "https://oasislmf.github.io/_images/OASIS_LMF_COLOUR.png",
"backgroundColor": "#FFFFFF",
"altText": "OasisLMF logo"
}
Expand Down
2 changes: 1 addition & 1 deletion redoc/model_settings/redoc_template.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"description": "<TEXT HERE>",
"version": "<ODS_VERSION>",
"x-logo": {
"url": "https://oasislmf.github.io/_static/OASIS_LMF_COLOUR.png",
"url": "https://oasislmf.github.io/_images/OASIS_LMF_COLOUR.png",
"backgroundColor": "#FFFFFF",
"altText": "OasisLMF logo"
}
Expand Down
2 changes: 1 addition & 1 deletion src/_templates/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<div class="sidebar-sticky">
<div class="logo">
<a href="https://github.com/OasisLMF">
<img src="https://oasislmf.github.io/_static/OASIS_LMF_COLOUR.png" alt="{{ 'Oasis Logo' }}" />
<img src="https://oasislmf.github.io/_images/OASIS_LMF_COLOUR.png" alt="{{ 'Oasis Logo' }}" />
</a>
</div>
{%- for sidebar_section in sidebars %}
Expand Down
7 changes: 3 additions & 4 deletions src/home/git-repo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,9 @@ OasisAzureDeployment can be used to manage, deploy, run, monitor, and configure

* `OasisEvaluation <https://github.com/OasisLMF/OasisEvaluation>`_

The Oasis Evalutaion repository can be use to spin up an Oasis enviroment to quickly and efficiently run and test models.
The Oasis Platform release now includes a full API for operating catastrophe models and a general consolidation of the
platform architecture. Windows SQL server is no longer a strict requirement. The platform can be run via docker containers
on a single machine or, if required, scaled up to run on a cluster.
The OasisEvaluation repository provides a streamlined way to run the Oasis stack in multi-container environment using
docker-compose. This is intended for locally testing the OasisPlatform 1 with a toy model example OasisPiWind, via the Web UI
OasisUI.

----

Expand Down
43 changes: 1 addition & 42 deletions src/home/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Overview

----

.. figure:: ../images/oasis_ecosystem.jpg
.. figure:: ../images/oasis_ecosystem_new.png
:alt: Oasis Ecosystem

Oasis Ecosystem
Expand Down Expand Up @@ -59,44 +59,3 @@ It is designed with a model developer or academic user in mind, who are likely t

**Oasis Model Library** is a hosted catalogue for Oasis models, hosted in AWS.
It allows regression of the models after updates to the Oasis Platform code, and validation of model operation and scalability within a hosted Oasis Platform.


..
This doesn't really work - gets messy having an index inside of the same index
..
.. toctree::
:titlesonly:
:caption: Home:

introduction.rst
git-repo.rst
FAQs.rst

.. toctree::
:titlesonly:
:caption: Use Cases:

../use_cases/model-developer
../use_cases/model-users
../use_cases/installing-deploying-Oasis

.. toctree::
:titlesonly:
:caption: Sections:

../sections/API.rst
../sections/deployment.rst
../sections/errors.rst
../sections/financial-module.rst
../sections/keys-service.rst
../sections/ktools-pytools.rst
../sections/Oasis-evaluation.rst
../sections/Oasis-model-data-formats.rst
../sections/Oasis-models.rst
../sections/Oasis-platform.rst
../sections/Oasis-UI.rst
../sections/Oasis-workflow.rst
../sections/OasisLMF-package.rst
../sections/OED.rst
../sections/options.rst
../ sections/results.rst
Binary file modified src/images/correlation1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/correlation2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/correlation3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/correlation4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/oasis_ecosystem_new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/plat2_arch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/sampling1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/sampling2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Overview

----

.. figure:: images/oasis_ecosystem.jpg
.. figure:: images/oasis_ecosystem_new.png
:alt: Oasis Ecosystem

Oasis Ecosystem
Expand Down Expand Up @@ -82,13 +82,15 @@ It allows regression of the models after updates to the Oasis Platform code, and
:titlesonly:
:caption: Sections:

sections/absolute-damage.rst
sections/analysis_settings
sections/API.rst
sections/camel.rst
sections/correlation.rst
sections/deployment.rst
sections/disaggregation.rst
sections/financial-module.rst
sections/geocoding.rst
sections/keys-service.rst
sections/ktools.rst
sections/model-data-library.rst
Expand All @@ -111,12 +113,14 @@ It allows regression of the models after updates to the Oasis Platform code, and
sections/platform_1
sections/platform_2
sections/post-loss-amplification.rst
sections/pre-analysis-adjustments.rst
sections/pytools.rst
sections/releases.rst
sections/results.rst
sections/SaaS-providers.rst
sections/sampling-methodology.rst
sections/versioning.rst

..
sections to be populated: sections/pre-analysis-adjustments.rst, sections/sampling-methodology.rst, sections/errors.rst
sections to be populated: sections/pre-analysis-adjustments.rst, sections/errors.rst, sections/complex-model.rst

7 changes: 3 additions & 4 deletions src/sections/API.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,9 @@ Introduction:

----

Oasis has a full REST API for managing exposure data and operating modelling workflows. API Swagger documentation can be
found `here <http://api.oasislmfdev.org/swagger/>`_. An evaluation version of the Oasis platform and using can be deployed
using the `Oasis evaluation repository <https://github.com/OasisLMF/OasisEvaluation>`_. This includes a Jupyter notebook
that illustrates the basic operation of the API, using the Python API client.
An evaluation version of the Oasis platform and using can be deployed using the `Oasis evaluation repository
<https://github.com/OasisLMF/OasisEvaluation>`_. This includes a Jupyter notebook that illustrates the basic
operation of the API, using the Python API client.

The API schemas can be found here:

Expand Down
6 changes: 3 additions & 3 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 Expand Up @@ -103,7 +103,7 @@ ODS Tools can be installed via pip by running the following command:
pip install ods-tools
|

Once installed, ODS Tools can be used utilised via the command line interface to quickly convert oed files.
Once installed, ODS Tools can be used via the command line interface to quickly convert oed files.

Example :

Expand Down
61 changes: 53 additions & 8 deletions src/sections/Oasis-evaluation.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,63 @@
Oasis Evaluation
================

The Oasis Evalutaion repository can be use to spin up an Oasis enviroment to quickly and efficiently run and test models.
The Oasis Platform release now includes a full API for operating catastrophe models and a general consolidation of the
platform architecture. Windows SQL server is no longer a strict requirement. The platform can be run via docker containers
on a single machine or, if required, scaled up to run on a cluster.
The OasisEvaluation repository provides a streamlined way to run the Oasis stack in multi-container environment using docker-compose.
This is intended for locally testing the `OasisPlatform 1 <https://github.com/OasisLMF/OasisPlatform/tree/main-platform1>`_ with a toy model example `OasisPiWind <https://github.com/OasisLMF/OasisPiWind>`_, via the Web UI `OasisUI <https://github.com/OasisLMF/OasisUI>`_.



.. _installing_oasis:

Installing Oasis
****************

1. Install prerequisites, ``docker``, ``docker-compose``, and ``git``
2. (optional) Edit the software versions at the top of ``install.sh`` installation script, These control the oasis versions installed

|
.. code-block:: python

export VERS_API=1.28.0
export VERS_WORKER=1.28.0
export VERS_UI=1.11.6
export VERS_PIWIND='stable/1.28.x'
|

These control the oasis versions installed
- ``VERS_API``, OasisPlatform server version
- ``VERS_WORKER``, OasisPlatform worker version
- ``VERS_UI``, OasisUI container version
- ``VERS_PIWIND``, the PiWind branch to run.

3. Run the installaion script

|
.. code-block:: python

./install.sh
|




----

Oasis Installation Guide: Windows 10 OS
#######################################

.. youtube:: SxRt5E-Y5Sw

|
Oasis Installation Guide: Linux based OS
########################################

.. youtube:: OFLTpGGEM10


Docker support is the main requirement for running the platform. A Linux based installation is the main focus of this
example deployment. Running the install script from this repository automates install process of the OasisPlatform API v1,
User Interface and example PiWind model.

GitHub repository:
------------------

----

`Oasis Platform Evaluation <https://github.com/OasisLMF/OasisEvaluation#readme>`_.
`Oasis Platform Evaluation <https://github.com/OasisLMF/OasisEvaluation#readme>`_.
60 changes: 53 additions & 7 deletions src/sections/Oasis-models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,17 @@ This is a single event model which allows users to apply deterministic losses to
in the OED location file. It is similar to the ``exposure`` feature in the oasislmf package, but can be deployed as a model in
it's own right to model deterministic losses which can then be passed through the Oasis financial module.

This model is availible to use `here <https://github.com/OasisLMF/OasisModels/tree/develop/DeterministicModel>`_.

----

Paris Windstorm
****************

This is very small, single peril model used for demonstration of how to build a simple model in Oasis.

This model is availible to use `here <https://github.com/OasisLMF/OasisModels/tree/develop/ParisWindstorm>`_.

----

PiWind
Expand All @@ -43,16 +47,33 @@ PiWind
This is the original test model in Oasis and is an example of a multi-peril model implementation representing ficticious
events with wind and flood affecting the Town of Melton Mowbray in England.

This model is availible to use `here <https://github.com/OasisLMF/OasisModels/tree/develop/PiWind>`_.

More information on this model can be found here: :ref:`piwind_models`

----

PiWind Absolute Damage
**********************

This model expands upon the PiWind model with the absolute damage option. This option allows model providers to include
absolute damage amounts rather than damage factors in the damage bin dictionary. If the damage factors are less than or
equal to 1 in the damage bin dictionary, the factor will be applied as normal during the loss calculation, by applying the
sampled damage factor to the TIV to give a simulated loss; but with absolute damage factors, where the factor is greater
than 1, the TIV is not used in the calculation at all, but rather the absolute damage is applied as the loss.

This model is availible to use from `here <https://github.com/OasisLMF/OasisModels/tree/develop/PiWindAbsoluteDamage>`_.

----

PiWind Complex Model
********************

This is a version of the PiWind model which uses the complex model integreation approach to generate ground up losses in a
custoim module, which then sits in the workflow and replaces the standard ground up loss calculation from Oasis.

This model is availible to use from `here <https://github.com/OasisLMF/OasisModels/tree/develop/PiWindComplexModel>`_.

----

PiWind Postcode
Expand All @@ -61,6 +82,32 @@ PiWind Postcode
This is a variant of the original PiWind model designed for running exposures whose locations are known at postcode level
rather than by latitude and longitude. This model demonstrates the disaggregation features of Oasis.

This model is availible to use `here <https://github.com/OasisLMF/OasisModels/tree/develop/PiWindPostcode>`_.

----

PiWind Post Loss Amplification
******************************

This is a version of the PiWind model with post loss amplification factors applied. Major catastrophic events can
give rise to inflated and/or deflated costs depending on that specific situation. To account for this, the ground up
losses produced by the GUL calculation component are multiplied by post loss amplification factors, by the component
plapy.

This model is availible to use `here <https://github.com/OasisLMF/OasisModels/tree/develop/PiWindPostLossAmplification>`_.

----

PiWind Post Pre Analysis
************************

This model builds upon the original PiWind model with a pre-analysis adjustment hook. This step allows the user to modify input
files before they are processed in the analysis. This functionality is utilised by this model by implementing an external geocoder:
this checks the location data before it is analysed for any addresses that are missing OED location data. If an address is found t
o be incomplete, it is geocoded to fill these gaps.

This model is availible to use `here <https://github.com/OasisLMF/OasisModels/tree/develop/PiWindPreAnalysis>`_.

----

PiWind Single Peril
Expand All @@ -69,14 +116,12 @@ PiWind Single Peril
This is a simplified variant of the original PiWind model which has single peril (wind only) and would be a good basis for
a single peril model in Oasis.

|

.. note::
More information about these models can be found `here <https://github.com/OasisLMF/OasisModels/tree/develop>`_.

This model is availible to use `here <https://github.com/OasisLMF/OasisModels/tree/develop/PiWindSinglePeril>`_.

----

.. note::
More information about these models can be found `here <https://github.com/OasisLMF/OasisModels/tree/develop>`_.
|

.. _piwind_models:
Expand All @@ -87,8 +132,9 @@ 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.
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>`_.

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
Loading