Skip to main content

Command line interface and Python API for accessing Copernicus Marine data and related services.

Project description

Copernicus Marine Service Toolbox (CLI & Python)

PyPI conda-forge
PyPI Supported Versions Supported Platforms Docker Documentation Code Style Licence Downloads

Copernicus Marine Service and Mercator Ocean international logos

Features

The Copernicus Marine Toolbox offers capabilities through both Command Line Interface (CLI) and Python API:

  • Metadata Information: List and retrieve metadata information on all products, datasets, variables.
  • Subset Datasets: Subset datasets to extract only the parts of interest, in preferred format, such as Analysis-Ready Cloud-Optimized (ARCO) Zarr or NetCDF file format.
  • Advanced Filters: Apply simple or advanced filters to get multiple files, in original formats like NetCDF/GeoTIFF, via direct Marine Data Store connections.
  • No Quotas: Enjoy no quotas, neither on volume size nor bandwidth.

Documentation

For detailed and up-to-date information, please refer to the Copernicus Marine Toolbox Documentation. It includes exhaustive guides, API specifications, and tutorials, automatically versioned.

For additional documentation and smooth transition for users of legacy services such as MOTU, OPeNDAP, or FTP, visit our Help Center.

Installation

The Copernicus Marine Toolbox can be installed and utilized in various ways to suit different user preferences and system configurations. For detailed guidance, refer to the installation page of the toolbox documentation.

Mamba | Conda

mamba install conda-forge::copernicusmarine --yes

or conda:

conda install -c conda-forge copernicusmarine

Pip

python -m pip install copernicusmarine

Binaries (no-installation)

These binaries require no installation and run independently on the user system. Simply download (from release page or check the installation page of the toolbox documentation) and run the binary for instant access to the toolbox Command Line Interface functionalities.

Docker

docker pull copernicusmarine/copernicusmarine:latest

Dependencies

Note that the use of xarray<2024.7.0 with numpy>=2.0.0 leads to inconsistent results. See this issue: xarray issue.

Command Line Interface (CLI)

The --help option

To discover commands and their available options, consider appending --help on any command line.

Example:

copernicusmarine --help

Returns:

Usage: copernicusmarine [OPTIONS] COMMAND [ARGS]...

Options:
  -V, --version  Show the version and exit.
  -h, --help     Show this message and exit.

Commands:
  describe  Print Copernicus Marine catalogue as JSON.
  get       Download originally produced data files.
  login     Create a configuration file with your Copernicus Marine credentials.
  subset    Download subsets of datasets as NetCDF files or Zarr stores.

Python package (API)

The copernicusmarine exposes a Python interface to allow you to call commands as functions.

Version management

We are using semantic versioning X.Y.Z → MAJOR.MINOR.PATCH → for example 1.0.2. We follow the SEMVER principles:

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes
  • MINOR version when you add functionality in a backward compatible manner
  • PATCH version when you make backward compatible bug fixes

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

Contribution

We welcome contributions from the community to enhance this package. If you find any issues or have suggestions for improvements, please check out our Report Template.

You are welcome to submit issues to the GitHub repository or create a pull request; however, please be advised that we may not respond to your request or may provide a negative response.

Future improvements & Roadmap

To keep up to date with the most recent and planned advancements, including revisions, corrections, and feature requests generated from users' feedback, please refer to our Roadmap.

Join the community

Get in touch!

Licence

Licensed under the EUPL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

copernicusmarine-2.0.1.tar.gz (74.4 kB view details)

Uploaded Source

Built Distribution

copernicusmarine-2.0.1-py3-none-any.whl (98.9 kB view details)

Uploaded Python 3

File details

Details for the file copernicusmarine-2.0.1.tar.gz.

File metadata

  • Download URL: copernicusmarine-2.0.1.tar.gz
  • Upload date:
  • Size: 74.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.12.0 Linux/5.15.0-122-generic

File hashes

Hashes for copernicusmarine-2.0.1.tar.gz
Algorithm Hash digest
SHA256 badbc5a9aa3d2c7d5952762447fda7b577467e186fd8607b29bbc6ce850f30e4
MD5 086753965b5479ded87422edc9d37e83
BLAKE2b-256 94164e4f2f236c3e2cb27c9d441c02febf4713db73f2f013d27ce832d21827b1

See more details on using hashes here.

File details

Details for the file copernicusmarine-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: copernicusmarine-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 98.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.0 CPython/3.12.0 Linux/5.15.0-122-generic

File hashes

Hashes for copernicusmarine-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2fe46091d0a280e6972c22bed79319e4f1c020cb29e1c5e8a4a2195ef880d905
MD5 782ff20eedc8bdaa7c6adee924098524
BLAKE2b-256 fa1b9848a4a1a747def5566a67b3eee4d482eefccb1daa4c7448ab4229d9dff2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page