Skip to content

Commit

Permalink
add reference to tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
alexis-barge committed Dec 5, 2024
1 parent 3b1a19d commit 5e3aaa9
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 9 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
30 changes: 21 additions & 9 deletions docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://eophis.readthedocs.io/en/latest/concept_motivation.html>`_.

*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 <https://eophis.readthedocs.io/en/latest/license.html>`_.


Strategy
--------
-------------------------------

`OASIS <https://oasis.cerfacs.fr/en/>`_ 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 <https://github.com/morays-community>`_ : coupled experiments with ocean codes
.. note ::
Newcomers are welcome to start with:
- `Eophis tutorial <https://eophis.readthedocs.io/en/latest/tutorial.html>`_
- `Eophis concepts description <https://eophis.readthedocs.io/en/latest/concept_object.html>`_
- `Quickstart from container <https://eophis.readthedocs.io/en/latest/install.html#from-container>`_
People familiar with Eophis may find useful informations in these sections:
- `Eophis detailed usage <https://eophis.readthedocs.io/en/latest/usage.html>`_
- `Eophis native installation <https://eophis.readthedocs.io/en/latest/install.html#from-sources>`_
Advanced users can get inspired by visiting project pages that are using Eophis:
- Python scripts deployed in ocean models with Eophis : `Morays <https://github.com/morays-community>`_
People who wish to contribute to Eophis are invited to read:
- `Contribution guidelines <https://github.com/meom-group/eophis/blob/main/CONTRIBUTING.md>`_
- `Eophis test suite <https://eophis.readthedocs.io/en/latest/tests.html>`_

0 comments on commit 5e3aaa9

Please sign in to comment.