-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix platform use component table fix
- Loading branch information
Showing
3 changed files
with
78 additions
and
52 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>`_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters