Copernicus Data Space Ecosystem: sample notebooks

This repository contains sample Jupyter notebooks for the Copernicus Data Space Ecosystem.

Notebooks are grouped per kernel: sentinelhub, openeo and geo.

Contributor tips

Pull request checklist (new)

When contributing changes to the samples, please review the following checklist before opening a pull request.

• Kernel spec metadata was correctly set (check_kernelspec action)
• Tests pass (test-samples action)
• Code is formatted and linted (Python linting action)
• If applicable, documentation has been updated to reflect changes

Extra information about each check can be found below.

Kernel spec metadata

In case of editing the notebook samples outside the Copernicus Data Space Ecosystem Jupyter notebooks service, make sure to update the kernel spec (metadata.kernelspec.name) before pushing, otherwise the sample will be loaded with the wrong kernel:

• for Sentinelhub kernels, use sentinelhub
• for OpenEO samples, use openeo
• for generic Geo science kernels, use geo

E.g. for OpenEO:

...
"metadata": {
  "kernelspec": {
    "display_name": "OpenEO",
    "language": "python",
    "name": "openeo"
  },
...

Automated testing

If you want your sample to be automatically tested, add it to the .tests file. A GitHub action will pull the Jupyterlab container and automatically test the listed notebook samples.

Mind that in case of automated testing samples can't depend on interactive input, like specifying user credentials. If you need credentials to run the notebook, please notify one of the admins.

If you encounter certain notebook samples in the testing pipeline that are failing that were not changed in your pull request. Please notify the owner of the sample.

Pre-commit hook

To ensure a consistent code style and formatting in this repository, we use the the black code formatter.

We recommend to set up a (git) pre-commit hook, to automatically run code checks and apply formatting tweaks before each commit.

• Install pre-commit on your system, for example directly in your development environment with

  pip install pre-commit
  

• Install the pre-commit git hook defined by the .pre-commit-config.yaml config of this repository:

  pre-commit install
  

The pre-commit hooks will now run automatically before each commit, checking the code for any style violations and automatically formatting it if needed.