Skip to main content

Tools for creating, validating, and searching EarthCODE Open Science Catalog metadata.

Project description

Introduction

This repository provides Python tools for creating, validating, and searching EarthCODE Open Science Catalog metadata.

Installation

pip install earthcode

Publishing to the Open Science catalog

In the guide/ folder you can find instructions how to publish your results to the Open Science Catalog. Start with the guide/0.Prerequisites - local.ipynb notebook if you are running the examples locally. Alternatively, start with guide/0.Prerequisites-EarthCODE-Workspaces.ipynb if you are using the EarthCODE workspace.

Examples

In the examples folder you can find notebooks that show:

  • How to use the library to semantically search the Open Science Catalog - examples/earthcode_data_discovery.ipynb
  • (Experimental) How to combine the library and the OSC editor - examples/contribute_via_osc_editor.ipynb
  • How to validate a local copy of the catalog and open a PR - examples/contribute_via_pr_osc.ipynb

For Developers:

Local install

  1. git clone https://github.com/ESA-EarthCODE/earthcode-library.git
  2. Install pixi - https://pixi.sh/dev/installation/
  3. cd earthcode-library
  4. pixi install
  5. pixi run jupyter lab

You can run tests through pixi run pytest. If running on Windows use pixi run pytest --basetemp=C:\t to avoid long path errors, since some of the project names are >260 chars.

To create a new release and publish it

edit pyproject.toml to 1.1.4 and run

  • pixi lock
  • git add pyproject.toml pixi.toml pixi.lock
  • git commit -m "Release v1.1.4"
  • git push origin main
  • git tag -a v1.1.4 -m "Release v1.1.4"
  • git push origin v1.1.4

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

earthcode-0.1.8.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

earthcode-0.1.8-py3-none-any.whl (55.9 kB view details)

Uploaded Python 3

File details

Details for the file earthcode-0.1.8.tar.gz.

File metadata

  • Download URL: earthcode-0.1.8.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for earthcode-0.1.8.tar.gz
Algorithm Hash digest
SHA256 25d7b04287b17b292c27bdcb3d3e5f016fa1d3adb457536e48ce06b481e7f2cd
MD5 4c60b9496ae69d914493e10a05b54aea
BLAKE2b-256 c7fb02955a27acc0f686fe13dcfccba16d704bf289725007e89923876aca3dbb

See more details on using hashes here.

Provenance

The following attestation bundles were made for earthcode-0.1.8.tar.gz:

Publisher: publish.yml on ESA-EarthCODE/earthcode-library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file earthcode-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: earthcode-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 55.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for earthcode-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 33015c2f70cc3ac1ac6bba7f7804ea568ffb6001654ca218705b66aa9e1807dd
MD5 21a76a8f02b42f55bffc6915e352d14e
BLAKE2b-256 8e7354666c08299679299969cdf8e07e9613c6396acd85e02e772b64d0ba7a3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for earthcode-0.1.8-py3-none-any.whl:

Publisher: publish.yml on ESA-EarthCODE/earthcode-library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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