Metadata-Version: 2.3
Name: oceanbench
Version: 0.0.1
Summary: 
Author: Mathis Bertin
Author-email: mbertin@mercator-ocean.fr
Requires-Python: >=3.12.9
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: aiohttp (>=3.0.0)
Requires-Dist: copernicusmarine (==2.0.1)
Requires-Dist: dask (>=2022)
Requires-Dist: gsw (>=3.6.19,<4.0.0)
Requires-Dist: matplotlib (>=3.10.0,<4.0.0)
Requires-Dist: netcdf4 (>=1.7.2,<2.0.0)
Requires-Dist: numcodecs (==0.15.1)
Requires-Dist: parcels (>=3.1.2,<4.0.0)
Requires-Dist: requests (>=2.27.1)
Requires-Dist: seaborn (>=0.13.2,<0.14.0)
Requires-Dist: xarray (==2025.1.2)
Requires-Dist: zarr (==2.18.4)
Description-Content-Type: text/markdown

<!--
SPDX-FileCopyrightText: 2025 Mercator Ocean International <https://www.mercator-ocean.eu/>

SPDX-License-Identifier: EUPL-1.2
-->

# OceanBench

[![Supported Platforms](https://img.shields.io/badge/platform-linux-lightgrey)](https://en.wikipedia.org/wiki/Linux)
[![License](https://img.shields.io/badge/licence-EUPL-lightblue)](https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12)

OceanBench is a benchmarking tool to evaluate ocean models against reference ocean analysis datasets as well as observations.

## Score table and model comparison

The official score table is available on the OceanBench website.

## Definitions of evaluation methods

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

## Evaluate your model with OceanBench

Checkout [this notebook](https://github.com/mercator-ocean/oceanbench/blob/main/assets/glonet_sample.report.ipynb) that evaluates a sample (two forecasts) of the GLONET system on OceanBench.
The resulting executed notebook is used as the evaluation report of the model, 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.


### Installation

```bash
git clone git@github.com:mercator-ocean/oceanbench.git && cd oceanbench/ && pip install --editable .
```

### Dependency on the Copernicus Marine Service

Running OceanBench uses the [Copernicus Marine Toolbox](https://github.com/mercator-ocean/copernicus-marine-toolbox/) and hence requires authentication to the [Copernicus Marine Service](https://marine.copernicus.eu/).

> If you're running OceanBench in a non-interactive way, please follow the [Copernicus Marine Toolbox documentation](https://toolbox-docs.marine.copernicus.eu/en/v2.0.1/usage/quickoverview.html#copernicus-marine-toolbox-login) to login to the Copernicus Marine Service before running the bench.

## Contribution

Your help to improve OceanBench is welcome.
Please first read contribution instructions [here](CONTRIBUTION.md).

## License

Licensed under the [EUPL-1.2](https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12) license.

