Morays

M imicking O cean R elevance with A rtificiall Y intelligent S nakes

Morays is a GitHub organization that provides a collection of deployment examples of the Eophis package in ocean models. It also proposes a solution for sharing the model experiments across centers. Our ambition is to offer a platform for fostering exchanges amongst Eophis users.


OASIS3-MCT is a parallelized Fortran coupling library that performs field exchanges between coupled executables. Eophis is a Python library that facilitates the creation and the configuration of an OASIS3-MCT environment in a Python script to couple with Fortran/C geoscientific codes. It can be deployed with any geoscientific model if it does possess an OASIS3-MCT interface.

In this context, a Morays experiment is an ocean simulation in which the physical model sends fields towards an external Python script deployed by Eophis. The results computed by the Python model are sent back to the ocean and retroactively used for the solution.

_images/morays_eophis.png
Typical applications include:
  • Hybrid Machine Learning (ML) / Physics modeling

  • Deployment of fast evolving high-level libraries in stable low-level codes

  • Prototypal code testing


Main purpose of this organization is to store examples of Morays experiments for different ocean models. So far, codes taken into consideration in this project are:


Every Morays experiments are documented in a self contained separate GitHub repository, that provides all the material for reproducing the use case. List of available experiments can be found in this section. A last objective of this documentation is to give detailed guidelines to create custom Morays test cases.

Note

Newcomers are welcome to start with these tutorials:
People familiar with Eophis, ocean models or Morays framework are encouraged to follow these tutorials:
Advanced users can find advanced tools and informations in corresponding model sections:
People who wish to contribute to the Morays collection with their own experiments are invited to follow: