Skip to main content

An analysis environment for satellite and other earth observation data

Project description

Open Data Cube Core

Build Status Coverage Status Documentation Status Discord

Overview

The Open Data Cube Core provides an integrated gridded data analysis environment for decades of analysis ready earth observation satellite and related data from multiple satellite and other acquisition systems.

Documentation

See the user guide for installation and usage of the datacube, and for documentation of the API.

Join our Discord if you need help setting up or using the Open Data Cube.

Please help us to keep the Open Data Cube community open and inclusive by reading and following our Code of Conduct.

This is a 1.9.x series release of the Open Data Cube. If you are migrating from a 1.8.x series release, please refer to the 1.8.x to 1.9.x Migration Notes.

Requirements

System

  • PostgreSQL 15+

  • Python 3.10+

Developer setup

  1. Clone:

    • git clone https://github.com/opendatacube/datacube-core.git

  2. Create a Python environment for using the ODC. We recommend Mambaforge as the easiest way to handle Python dependencies.

mamba env create -f conda-environment.yml
conda activate cubeenv
  1. Install a develop version of datacube-core.

cd datacube-core
pip install --upgrade -e .
  1. Install the pre-commit hooks to help follow ODC coding conventions when committing with git.

pre-commit install
  1. Run unit tests + PyLint

Install test dependencies using:

pip install --upgrade -e '.[test]'

If install for these fails, please lodge them as issues.

Run unit tests with:

./check-code.sh

(this script approximates what is run by GitHub Actions. You can alternatively run pytest yourself).

  1. (or) Run all tests, including integration tests.

    ./check-code.sh integration_tests

    • Assumes the existence of two password-less Postgres databases running on localhost called pgintegration and pgisintegration.

    • Otherwise copy integration_tests/integration.conf to ~/.datacube_integration.conf and edit to customise.

    • For instructions on setting up a password-less Postgres database, see

      the developer setup instructions.

Alternatively one can use the opendatacube/datacube-tests docker image to run tests. This docker includes database server pre-configured for running integration tests. Add --with-docker command line option as a first argument to ./check-code.sh script.

./check-code.sh --with-docker integration_tests

To run individual tests in a docker container

docker build --tag=opendatacube/datacube-tests-local --no-cache --progress plain -f docker/Dockerfile .

docker run -ti -v $(pwd):/code opendatacube/datacube-tests-local:latest pytest integration_tests/test_filename.py::test_function_name

Developer setup on Ubuntu

Building a Python virtual environment on Ubuntu suitable for development work.

Install dependencies:

sudo apt-get update
sudo apt-get install -y \
    autoconf automake build-essential make cmake \
    graphviz \
    python3-venv \
    python3-dev \
    libpq-dev \
    libyaml-dev \
    libnetcdf-dev \
    libudunits2-dev

Build the python virtual environment:

pyenv="${HOME}/.envs/odc"  # Change to suit your needs
mkdir -p "${pyenv}"
python3 -m venv "${pyenv}"
source "${pyenv}/bin/activate"
pip install -U pip wheel cython numpy
pip install -e '.[dev]'

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

datacube-1.9.5.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

datacube-1.9.5-py3-none-any.whl (424.4 kB view details)

Uploaded Python 3

File details

Details for the file datacube-1.9.5.tar.gz.

File metadata

  • Download URL: datacube-1.9.5.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for datacube-1.9.5.tar.gz
Algorithm Hash digest
SHA256 61ff403423e40fb425cbcfd9441dad5bc38d706627e99ac249925dd78a89a859
MD5 e68f391fb8e5482a5f1ee35eb70b200f
BLAKE2b-256 05f15c9faef6ba36e64466625a4eaacd198db19fc080f9d87963833745fc04bf

See more details on using hashes here.

Provenance

The following attestation bundles were made for datacube-1.9.5.tar.gz:

Publisher: main.yml on opendatacube/datacube-core

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

File details

Details for the file datacube-1.9.5-py3-none-any.whl.

File metadata

  • Download URL: datacube-1.9.5-py3-none-any.whl
  • Upload date:
  • Size: 424.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for datacube-1.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5413752d629d33d527e63365d15e22f26f45efe1d55a82e81406a7911fcc1a35
MD5 72b2bf491b968cbbad7a91f38f376f1b
BLAKE2b-256 86f01e74de01adab95a5884872ca6f2f63048edf61410887a67f46c75a538b3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for datacube-1.9.5-py3-none-any.whl:

Publisher: main.yml on opendatacube/datacube-core

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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page