Open Data Cube Manual

The Open Data Cube 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.

• Introduction
  • Overview
  • Use Cases
    • Large-scale workflows on HPC
    • Exploratory Data Analysis
    • Cloud-based Services
    • Standalone Applications
• Existing Deployments
  • Digital Earth Australia
  • Digital Earth Africa
  • Swiss Data Cube
  • Vietnam Open Data Cube
• Jupyter Notebooks
• Code Recipes
  • Display an RGB Image
  • Multi-Product Time Series
  • Polygon Drill
  • Line Transect
• Data Cube Ecosystem
  • API Access from Jupyter
  • OGC Web Services
  • Data Cube Explorer
  • Data Cube UI
  • Data Cube Stats
  • Cube in a Box
  • Command Line Interface

Installation and Data Loading

• Overview
  • Overview
• Types of Datasets
  • Indexed Datasets
  • Ingested Datasets
  • Provenance
• Installation
  • Miniconda (recommended)
  • Microsoft Windows
  • Ubuntu
  • Mac OS X
• Database Setup
  • Install PostgreSQL
  • Create Database
  • Create Configuration File
  • Initialise the Database Schema
• Environment Configuration
  • Runtime Configuration
  • Types of Indexes
• Indexing Data
  • Prerequisites for Indexing Data
  • Steps to Adding Data
  • Product Definition
  • Loading Product Definitions
  • Dataset Documents
  • Adding Data - Indexing
  • Indexing Data on Amazon(AWS S3)
• Ingesting Data
  • Ingestion Configuration
  • Ingestion Config
  • Ingest Some Data
• Product Definition
• Dataset Documents
  • EO3 Format
  • EO (deprecated)
  • Metadata Type Definition
• Dataset Preparation Scripts
  • 1. Preparing USGS Landsat Collection 1 - LEVEL1
  • 2. Preparing USGS Landsat Surface Reflectance - LEDAPS
  • 3. Prepare script and indexing Landsat data on AWS
  • Custom Prepare Scripts
• Command Line Tools
  • datacube
  • datacube-search
  • datacube-stacker
  • datacube-worker
  • datacube-fixer
  • datacube-ncml
• Data Replication
  • Simple Data Cube Replication Tool
  • Command line documentation
  • Caveats and limitations

Developer Guide

• API reference
  • Datacube Class
  • Data Discovery
  • Data Loading
  • Grid Processing API
  • Internal Data Model
  • Database Index API
  • Geometry Utilities
  • Masking
  • Writing Image Files
  • AWS Utilities
  • Dask Utilities
  • Query Class
  • User Configuration
  • Everything Else
• Developer Setup
  • Ubuntu Developer Setup
  • Windows Developer Setup
  • Mac OSX Developer Setup
• Virtual Products
  • Introduction
  • Using virtual products
  • Design
  • Components
  • Built in Transforms
  • User-defined transformations
• Architecture Guide
  • Introduction
  • High Level Architecture
  • Data Model
  • Metadata Index
  • Data Loading
  • Extending Datacube
• Release Process

About Data Cube

• What’s New
  • 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)
• Glossary
• ODC License

Support

The best way to get help with the Data Cube is to open an issue on Github.

Indices and tables

• Index

• Module Index

• Search Page