oceanbench 0.0.2

No project description provided

OceanBench: Evaluating ocean forecasting systems

OceanBench is a benchmarking tool to evaluate ocean forecasting systems against reference ocean analysis datasets (such as 2024 GLORYS reanalysis and GLO12 analysis as well as observations.

Score table and system comparison

The official score table is available on the OceanBench website.

Definitions of evaluation methods

The definitions of the methods used to evaluate systems are available on the OceanBench website and in the documentation.

Evaluate your system with OceanBench

Interactively

Checkout this notebook that evaluates a sample (two forecasts) of the GLONET system on OceanBench. The resulting executed notebook is used as the evaluation report of the system, and its content is used to fulfil the OceanBench score table.

You can replace the cell that open the challenger datasets with your code and execute the notebook.

Execute on your own resources

You will need to install OceanBench manually in your environment.

Installation

Using pip via PyPI

pip install oceanbench

From sources

git clone [e-mail]:mercator-ocean/oceanbench.git && cd oceanbench/ && pip install --editable .

Execute on EDITO

You can open and manually execute the example notebook in EDITO datalab by clicking here:

Programmatically

Python

Once installed, you can evaluate your system using python with the following code:

import oceanbench

oceanbench.evaluate_challenger("path/to/file/opening/the/challenger/datasets.py", "notebook_report_name.ipynb")

More details in the documentation.

Dependency on the Copernicus Marine Service

Running OceanBench to evaluate systems with 1/12° resolution uses the Copernicus Marine Toolbox and hence requires authentication to the Copernicus Marine Service.

If you're running OceanBench in a non-interactive way, please follow the Copernicus Marine Toolbox documentation to login to the Copernicus Marine Service before running the bench.

Official evaluation

To officially submit your system to OceanBench, please open an issue attaching:

• The executed notebook resulting from an interactive or programmatic evaluation. The notebook should be re-executable in order to update the scores with new OceanBench versions (all official challengers are re-evaluated at each new version).
• The organization that leads the construction or operation of the system.
• A link to the reference paper of the system.
• The system method. For example, "Physics-based", "ML-based" or "Hybrid".
• The system type. For example, "Forecast (deterministic)" or "Forecast (ensemble)".
• The system initial conditions. For example, "GLO12/IFS".
• The approximate horizontal resolution of the system. For example, "1/12°" or "1/4°".

Contribution

Your help to improve OceanBench is welcome. Please first read contribution instructions here.

License

Licensed under the EUPL-1.2 license.

About

Implemented by:

As part of a fruitful collaboration with:

Powered by: