The Open Data Cube

The Open Data Cube is an open-source software ecosystem for managing and processing gridded Earth observation data. It has been designed to manage decades of analysis ready Earth observation satellite data and related data from multiple sources.

Overview

Information on the purpose of the Open Data Cube, as well as its design.

Overview

Setup

How to install the Open Data Cube.

Setup

Analysis

How to access and analyse data that is managed by an Open Data Cube.

Analysis

API

The Open Data Cube’s Python API reference.

API

About

About the Open Data Cube and its development.

About

Contents

• Overview
  • Overview
  • Use Cases
  • The Open Data Cube Software Ecosystem
    • Overview & Use Cases
    • The Open Data Cube Ecosystem
    • Architectural Overview
    • Datasets
    • Dataset metadata format
    • Ingested Datasets
    • Products
    • Metadata Types
    • Accessing Data
    • ODC Software Packages
    • Existing Deployments
• Setup
  • Mac OSX Developer Setup
    • Required software
    • Python and packages
    • Postgres testing database configuration
    • Verify it all works
  • Ubuntu Developer Setup
    • Required software
    • Python and packages
    • Postgres testing database configuration
    • Verify it all works
  • Windows Developer Setup
    • Required software
    • Python and packages
    • Postgres database configuration
    • Open Data Cube source and development configuration
    • Verify it all works
  • Migrating from ODC 1.8.x to 1.9.x
    • Major Changes between 1.8.x and 1.9.x
    • The New Postgis Index Driver
  • Command Line Tools
    • datacube
    • datacube-search
  • ODC Configuration (Basics)
    • ODC Configuration Overview
    • Configuration Files
    • Need to know more?
  • ODC Configuration (Details)
    • Summary
    • Migrating from datacube-1.8
  • Database Setup
    • Install PostgreSQL
    • Create Database
    • Create Configuration File
    • Initialise the Database Schema
    • Create Spatial Indexes (Postgis Driver Only)
  • Metadata Types
  • Product Definitions
  • Dataset Documents
    • EO3 Format
  • Step-by-step Guide to Indexing Data
    • Introduction
    • Steps Overview
    • Step 1. Creating a Product Definition
    • Step 2. Ensure Dataset Documents are complete
    • Step 3. Run the Indexing process
  • Indexing data from Amazon (AWS S3)
    • Configuring AWS CLI Credentials
    • Install AWS S3 Indexing Scripts
    • S3 Indexing Example
  • Extending the Open Data Cube
    • Support for Plug-in drivers
    • Data Read Plug-ins
    • Data Write Plug-ins
    • Index Plug-ins
    • Drivers Plugin Management Module
    • Data Cube Drivers API
    • References and History
• Analysis
  • Open Data Cube Cheatsheet
    • Connecting to the Open Datacube
    • Product Discovery
    • Dataset Searching & Querying
    • Data Loading
    • Virtual Products
    • Data Loading in Depth
    • Using Jupyter Notebooks
• API
  • Datacube Class
    • Datacube
  • Dataset
    • Dataset
  • Product
    • Product
  • Geometry Classes
    • datacube.utils.geometry.Coordinate
    • datacube.utils.geometry.BoundingBox
    • datacube.utils.geometry.CRS
    • datacube.utils.geometry.Geometry
    • datacube.utils.geometry.GeoBox
    • datacube.utils.geometry.BoundingBox
    • datacube.utils.geometry.gbox.GeoboxTiles
    • datacube.model.GridSpec
    • datacube.utils.geometry.CRSError
    • datacube.utils.geometry.CRSMismatchError
  • Measurement
    • Measurement
  • Metadata Type
    • MetadataType
  • LineageTree
    • LineageDirection
    • LineageTree
  • Range
    • Range
  • Query
    • Query
  • Dataset & Product Discovery
    • datacube.Datacube.list_products
    • datacube.Datacube.list_measurements
  • Dataset Querying
    • datacube.index.abstract.AbstractDatasetResource.get
    • datacube.index.abstract.AbstractDatasetResource.search
    • datacube.index.abstract.AbstractDatasetResource.search_by_metadata
    • datacube.index.abstract.AbstractDatasetResource.search_by_product
    • datacube.index.abstract.AbstractDatasetResource.search_eager
    • datacube.index.abstract.AbstractDatasetResource.search_product_duplicates
    • datacube.index.abstract.AbstractDatasetResource.search_returning
    • datacube.index.abstract.AbstractDatasetResource.search_summaries
    • datacube.index.abstract.AbstractDatasetResource.has
    • datacube.index.abstract.AbstractDatasetResource.bulk_has
    • datacube.index.abstract.AbstractDatasetResource.can_update
    • datacube.index.abstract.AbstractDatasetResource.count
    • datacube.index.abstract.AbstractDatasetResource.count_by_product
    • datacube.index.abstract.AbstractDatasetResource.count_by_product_through_time
    • datacube.index.abstract.AbstractDatasetResource.count_product_through_time
    • datacube.index.abstract.AbstractDatasetResource.get_derived
    • datacube.index.abstract.AbstractDatasetResource.get_field_names
    • datacube.index.abstract.AbstractDatasetResource.get_locations
    • datacube.index.abstract.AbstractDatasetResource.get_archived_locations
    • datacube.index.abstract.AbstractDatasetResource.get_datasets_for_location
  • Product Querying
    • datacube.index.abstract.AbstractProductResource.can_update
    • datacube.index.abstract.AbstractProductResource.get
    • datacube.index.abstract.AbstractProductResource.get_by_name
    • datacube.index.abstract.AbstractProductResource.get_with_fields
    • datacube.index.abstract.AbstractProductResource.search
    • datacube.index.abstract.AbstractProductResource.search_robust
    • datacube.index.abstract.AbstractProductResource.search_by_metadata
    • datacube.index.abstract.AbstractProductResource.get_all
  • Data Loading
    • datacube.Datacube.load
    • Internal Loading Functions
    • Loading 3D Datasets
    • Group by
  • Masking
  • Bit Masking
    • Masking No Data Values
    • Masking with Bit-Flag Measurements
  • Dataset Writing
    • datacube.index.abstract.AbstractDatasetResource.add
    • datacube.index.abstract.AbstractDatasetResource.add_location
    • datacube.index.abstract.AbstractDatasetResource.archive
    • datacube.index.abstract.AbstractDatasetResource.archive_location
    • datacube.index.abstract.AbstractDatasetResource.remove_location
    • datacube.index.abstract.AbstractDatasetResource.restore
    • datacube.index.abstract.AbstractDatasetResource.restore_location
    • datacube.index.abstract.AbstractDatasetResource.update
    • Doc2Dataset
  • Product Writing
    • datacube.index.abstract.AbstractProductResource.from_doc
    • datacube.index.abstract.AbstractProductResource.add
    • datacube.index.abstract.AbstractProductResource.update
    • datacube.index.abstract.AbstractProductResource.update_document
    • datacube.index.abstract.AbstractProductResource.add_document
  • Index API
    • datacube.index.abstract
  • Configuration API
    • Executive Summary
    • Full API
  • Amazon Web Services (AWS)
    • datacube.utils.aws.s3_client
    • datacube.utils.aws.s3_open
    • datacube.utils.aws.s3_head_object
    • datacube.utils.aws.s3_fetch
    • datacube.utils.aws.s3_dump
    • datacube.utils.aws.s3_url_parse
    • datacube.utils.aws.auto_find_region
    • datacube.utils.aws.get_aws_settings
    • datacube.utils.aws.get_creds_with_retry
    • datacube.utils.aws.mk_boto_session
    • datacube.utils.aws.ec2_current_region
    • datacube.utils.aws.ec2_metadata
    • datacube.utils.aws.configure_s3_access
  • Writing GeoTIFFs
    • datacube.utils.cog.write_cog
    • datacube.utils.cog.to_cog
  • Dask
    • datacube.utils.dask.start_local_dask
    • datacube.utils.dask.partition_map
    • datacube.utils.dask.pmap
    • datacube.utils.dask.compute_tasks
    • datacube.utils.dask.save_blob_to_file
    • datacube.utils.dask.save_blob_to_s3
  • Geometry
    • Creating Geometries
    • Spatial Operations
    • Utilities
• About
  • What’s New
    • v1.9.2 (26th February 2025)
    • v1.9.1 (25th February 2025)
    • v1.9.0 (23rd December 2024)
    • v1.9.0-rc13 (16th December 2024)
    • v1.9.0-rc12 (9th December 2024)
    • v1.9.0-rc11 (28th October 2024)
    • v1.9.0-rc9 (3rd July 2024)
    • v1.9.0-rc8 (18th June 2024)
    • v1.9.0-rc7 (17th June 2024)
    • v1.9.0-rc5 (5th June 2024)
    • v1.9.0-rc4 (15th April 2024)
    • v1.9.0-rc3 (27th March 2024)
    • v1.9.0-rc1 (27th March 2024)
    • v1.8.next
    • v1.8.20 (9th December 2024)
    • v1.8.19 (2nd July 2024)
    • v1.8.18 (27th March 2024)
    • v1.8.17 (8th November 2023)
    • v1.8.16 (17th October 2023)
    • v1.8.15 (11th July 2023)
    • v1.8.14 (28th June 2023)
    • v1.8.13 (6th June 2023)
    • v1.8.12 (7th March 2023)
    • v1.8.11 (6 February 2023)
    • v1.8.10 (30 January 2023)
    • v1.8.9 (17 November 2022)
    • v1.8.8 (5 October 2022)
    • v1.8.7 (7 June 2022)
    • v1.8.6 (30 September 2021)
    • v1.8.5 (18 August 2021)
    • v1.8.4 (6 August 2021)
    • v1.8.3 (18 August 2020)
    • v1.8.2 (10 July 2020)
    • v1.8.1 (2 July 2020)
    • v1.8.0 (21 May 2020)
    • v1.7.0 (16 May 2019)
    • v1.7.0rc1 (18 April 2019)
    • v1.6.1 (27 August 2018)
    • v1.6.0 (23 August 2018)
    • v1.6rc2 (29 June 2018)
    • v1.6rc1 Easter Bilby (10 April 2018)
    • v1.5.4 Dingley Dahu (13th December 2017)
    • v1.5.3 Purpler Unicorn with Starlight (16 October 2017)
    • v1.5.2 Purpler Unicorn with Stars (28 August 2017)
    • v1.5.4 Dingley Dahu (13th December 2017)
    • v1.5.3 Purpler Unicorn with Starlight (16 October 2017)
    • v1.5.2 Purpler Unicorn with Stars (28 August 2017)
    • v1.5.1 Purpler Unicorn (13 July 2017)
    • v1.5.0 Purple Unicorn (9 July 2017)
    • v1.4.1 (25 May 2017)
    • v1.4.0 (17 May 2017)
    • v1.3.1 (20 April 2017)
    • v1.3.0
    • v1.2.2
    • v1.2.0 Boring as Batman (15 February 2017)
    • v1.1.18 Mushroom Milkshake (9 February 2017)
    • v1.1.17 Happy Festivus Continues (12 January 2017)
    • v1.1.16 Happy Festivus (6 January 2017)
    • v1.1.15 Minion Party Hangover (1 December 2016)
    • v1.1.14 Minion Party (30 November 2016)
    • v1.1.13 Black Goat (15 November 2016)
    • v1.1.12 Unnamed Unknown (1 November 2016)
    • v1.1.11 Unnamed Unknown (19 October 2016)
    • v1.1.10 Rabid Rabbit (5 October 2016)
    • v1.1.9 Pest Hippo (20 September 2016)
    • v1.1.8 Last Mammoth (5 September 2016)
    • v1.1.7 Bit Shift (22 August 2016)
    • v1.1.6 Lightning Roll (8 August 2016)
    • v1.1.5 Untranslatable Sign (26 July 2016)
    • v1.1.4 Imperfect Inspiration (12 July 2016)
    • v1.1.3 Speeding Snowball (5 July 2016)
    • v1.1.2 Wind Chill (28 June 2016)
    • v1.1.1 Good Idea (23 June 2016)
    • v1.1.0 No Spoon (3 June 2016)
    • 1.0.4 Square Clouds (3 June 2016)
    • 1.0.3 (14 April 2016)
    • 1.0.2 (23 March 2016)
    • 1.0.1 (18 March 2016)
    • 1.0.0 (11 March 2016)
    • pre-v1 (end 2015)
  • Migrating from ODC 1.8.x to 1.9.x
    • Major Changes between 1.8.x and 1.9.x
    • The New Postgis Index Driver
  • Glossary
  • ODC License
  • Release Process