From 5e3aaa9df3c154b407e37db2d6dc7ffb9b2c3b73 Mon Sep 17 00:00:00 2001 From: Alexis Barge Date: Thu, 5 Dec 2024 18:30:25 +0100 Subject: [PATCH] add reference to tutorial --- README.md | 5 +++++ docs/source/overview.rst | 30 +++++++++++++++++++++--------- 2 files changed, 26 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 34e12b8..3ad5e24 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,15 @@ Basically, Eophis allows to: - enhance packaging - add more detailed tutorial +## Quickstart + +Follow this [tutorial](https://eophis.readthedocs.io/en/latest/tutorial.html) to get started. + ## Usage, installation and test cases Check out corresponding sections in [Eophis documentation](https://eophis.readthedocs.io/en/latest/index.html) for further informations. + ## *Real-World* cases Those projects use Eophis: diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 2ba7304..3d074db 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -4,27 +4,39 @@ Eophis .. toctree:: :maxdepth: 0 -**Eophis** is a collection of tools that eases the deployment of Python scripts (such as pre-trained Machine Learning components) within Fortran/C geoscientific models through OASIS. +**Eophis** is a collection of tools that eases the deployment of Python scripts (such as pre-trained Machine Learning components) within Fortran/C geoscientific models through OASIS. Context of Eophis development is described `here `_. *Also it is the currently oldest known snake ancestra (2023)* Eophis source code, related files and documentation are distributed under an `MIT License which can be viewed here `_. - -Strategy --------- +------------------------------- `OASIS `_ is a parallelized Fortran coupling library that performs field exchanges between coupled executables. Last releases provided C and Python APIs, which enable coupling between non-homogeneously written codes. + Basically, Eophis allows to: (i) wrap an OASIS interface to exchange data with a coupled physic-based code (ii) wrap inference models into a simple in/out interface (iii) emulate time evolution to synchronize connexions between scripts. +------------------------------- -Demonstration Cases -------------------- -Here is a list of repositories containing realizations of coupled runs between different geophysical models and ML models deployed by Eophis: - - - `Morays `_ : coupled experiments with ocean codes +.. note :: + + Newcomers are welcome to start with: + - `Eophis tutorial `_ + - `Eophis concepts description `_ + - `Quickstart from container `_ + + People familiar with Eophis may find useful informations in these sections: + - `Eophis detailed usage `_ + - `Eophis native installation `_ + + Advanced users can get inspired by visiting project pages that are using Eophis: + - Python scripts deployed in ocean models with Eophis : `Morays `_ + + People who wish to contribute to Eophis are invited to read: + - `Contribution guidelines `_ + - `Eophis test suite `_