eophis

Couple Python and Machine Learning models with Geophysical simulation codes through OASIS

https://github.com/meom-group/eophis

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.5%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Couple Python and Machine Learning models with Geophysical simulation codes through OASIS

Basic Info
Statistics
  • Stars: 10
  • Watchers: 5
  • Forks: 1
  • Open Issues: 15
  • Releases: 6
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Citation

README.md

Eophis

Python Version C, Fortran, and MPI Required netcdf Required Documentation Status

Eophis is a collection of tools to ease the deployment of Python scripts (as pre-trained Machine Learning components) within Fortran/C geoscientific models through OASIS.

Also it is the currently oldest known snake ancestra (2023)

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.

Current development objectives - tools to write coupling info in geoscientific codes namelists - tools for time diagnostic - enhance packaging

Quickstart

Follow this tutorial to get started.

Usage, installation and test cases

Check out corresponding sections in Eophis documentation for further informations.

Real-World cases

Those projects use Eophis: - Morays : Python scripts deployed in ocean models with Eophis

How to cite

DOI

Please use above DOI or Cite this repository button in the About section of the repository

Contributing

See CONTRIBUTING.md to get started.

License

Copyright © IGE-MEOM

Eophis is distributed under the MIT License.

Owner

  • Name: MEOM Research Group
  • Login: meom-group
  • Kind: organization
  • Location: Grenoble, France

Data-driven computational oceanography

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Eophis
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Alexis
    family-names: Barge
    email: alexis.barge@proton.me
    affiliation: 'IGE, CNRS, Université Grenoble Alpes'
  - given-names: Julien
    family-names: Le Sommer
    email: julien.lesommer@univ-grenoble-alpes.fr
    affiliation: 'IGE, CNRS, Université Grenoble Alpes'
  - name: IGE-MEOM
    city: Saint Martin d'Hères
    country: FR
    post-code: '38400'
identifiers:
  - type: doi
    value: 10.5281/zenodo.13852038
    description: URL of Eophis version 1.0.0
  - type: url
    value: 'https://gmd.copernicus.org/articles/10/3297/2017/'
    description: OASIS-MCT3 heritage link
repository-code: 'https://github.com/meom-group/eophis'
abstract: >-
  Eophis is a collection of tools to facilitate the creation
  and the configuration of an OASIS environment in a Python
  script to couple with Fortran/C geoscientific codes.
  Typical applications include hybrid physics / ML modeling,
  deployment of fast evolving high-level libraries in stable
  low-level codes or prototypal code testing.
keywords:
  - Python
  - Fortran
  - Machine Learning
  - Geophysical models
  - Hybrid physics
  - OASIS coupling
license: MIT
commit: 0e8be458720d2d6838e860bd382cbcd8e21f673d
version: v1.0.0
date-released: '2024-09-27'

GitHub Events

Total
  • Issues event: 14
  • Watch event: 3
  • Delete event: 2
  • Issue comment event: 6
  • Push event: 83
  • Pull request event: 7
  • Fork event: 1
  • Create event: 2
Last Year
  • Issues event: 14
  • Watch event: 3
  • Delete event: 2
  • Issue comment event: 6
  • Push event: 83
  • Pull request event: 7
  • Fork event: 1
  • Create event: 2

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • alexis-barge (22)
  • lesommer (3)
  • Etienne-Meunier (1)
Pull Request Authors
  • alexis-barge (8)
Top Labels
Issue Labels
enhancement (12) documentation (8) CI (3) Packaging (2) bug (1)
Pull Request Labels
documentation (2) CI (1) Packaging (1)

Dependencies

pyproject.toml pypi
.github/workflows/python-documentation.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
docs/requirements.txt pypi
  • myst_parser *
  • sphinx ==7.1.2
  • sphinx-rtd-theme ==1.3.0rc1
.github/workflows/CI.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v4 composite