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 sources.

• About & Core Concepts
  • Overview
  • Use Cases
    • Overview & Use Cases
    • Architectural Overview
      • Database Diagram
    • Datasets
    • Types of Datasets
      • Indexed Datasets
      • Ingested Datasets
    • Products
      • Product Definition
        • Example Product Definition
        • Product Definition API
    • Metadata Types
    • Extensions & Related Software
      • Open Web Services
      • Data Cube Explorer
      • Cube in a Box
      • Data Cube Alchemist
      • Data Cube Statistician
      • Data Cube Stats
      • EO Datasets
    • Existing Deployments
      • Digital Earth Australia
      • Digital Earth Africa
      • Swiss Data Cube
      • Vietnam Open Data Cube
      • INEGI - Mexico Open Data Cube
      • Brazil Data Cube
      • Armenian Data Cube
      • Mongolian and Kyrgyz Data Cubes
• Data Access & Analysis
  • Connecting to the Open Datacube
    • Minimal Example
    • API
  • Product Discovery
    • Product Listings
    • Measurement Listings
  • Dataset Searching & Querying
    • Finding Datasets
    • Inspecting Datasets
  • Data Loading
    • Loading Datasets
    • Querying and Loading
  • Virtual Products
    • Introduction
    • Using virtual products
    • Design
    • Components
      • Product (Input)
      • Collate (Combining)
      • Juxtapose (Combining)
      • Reproject (Data modifying)
      • Transform (Data modifying)
      • Aggregate (Summary statistics)
    • Built in Transforms
      • Expressions
      • Make mask
      • Apply mask
      • To Float
      • Rename
      • Select
    • User-defined transformations
  • Data Loading in Depth
    • Types of Data Loading
      • Ad hoc data access
      • Large scale processing data access
    • Data Structures
      • Virtual Storage Resource
    • Data load in detail
      • Internal interfaces
    • Fuse function customisation
      • Problems with the current approach to fusing
    • Lazy load with dask
    • Limitations and problems
      • Possible Solutions
    • Storage Drivers
      • GDAL
      • S3IO
    • Supporting Diagrams
      • Data Read Process
      • Storage Classes
  • Using Juypter Notebooks
    • Digital Earth Australia Notebooks
    • Digital Earth Africa Notebooks
    • DEA and DE Africa Tools code
• Installing and managing the Open Data Cube
  • Mac OSX Developer Setup
    • Required software
    • Python and packages
      • Anaconda Python
    • Postgres database configuration
    • Open Data Cube source and development configuration
    • Verify it all works
  • Ubuntu Developer Setup
    • Required software
    • Python and packages
      • Anaconda Python
    • Postgres database configuration
    • Open Data Cube source and development configuration
    • Verify it all works
  • Windows Developer Setup
    • Required software
    • Python and packages
      • Anaconda Python
    • Postgres database configuration
    • Open Data Cube source and development configuration
    • Verify it all works
  • Command Line Tools
    • datacube
      • dataset
        • add
        • archive
        • info
        • purge
        • restore
        • search
        • update
        • uri-search
      • ingest
      • metadata
        • add
        • list
        • show
        • update
      • product
        • add
        • list
        • show
        • update
      • system
        • check
        • clone
        • init
      • user
        • create
        • delete
        • grant
        • list
    • datacube-search
      • datasets
      • product-counts
    • datacube-worker
  • Database Setup
    • Install PostgreSQL
    • Create Database
    • Create Configuration File
    • Initialise the Database Schema
  • Metadata Types
  • Product Definitions
  • Dataset Documents
    • EO3 Format
      • 3D dataset metadata
    • EO (deprecated)
  • Step-by-step Guide to Indexing Data
    • Introduction
    • Steps Overview
    • Step 1. Creating a Product Definition
      • Loading Product Definitions
    • 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
      • Example code to implement a reader driver
      • Example Pickle Based Driver
    • 3D Data Read Plug-ins
      • Example code to implement a 3D read
      • Example Xarray Based 3D Driver
    • Data Write Plug-ins
      • Example code to implement a writer driver
      • NetCDF Writer Driver
    • Index Plug-ins
      • Default Implementation
      • Null Implementation
      • Memory Implementation
      • PostGIS Implementation
    • Drivers Plugin Management Module
    • Data Cube Drivers API
    • References and History
  • Data Preperation Scripts
  • Landsat Samples
  • 1. Preparing USGS Landsat Collection 1 - LEVEL1
  • 2. Preparing USGS Landsat Surface Reflectance - LEDAPS
  • 3. Indexing data on AWS, an example using Sentinel-2
  • Custom Prepare Scripts
  • Ingesting Data
    • Ingestion Configuration
    • Ingestion Config
    • Ingest Some Data
• API Reference
  • Datacube Class
  • Dataset
  • Dataset Type
  • Geometry Classes
  • Measurement
  • Metadata Type
  • Range
  • Query
  • Tile
  • Dataset & Product Discovery
  • Dataset Querying
  • Product Querying
  • Data Loading
    • Internal Loading Functions
    • Loading 3D Datasets
    • Group by
  • Masking
  • Bit Masking
    • Masking No Data Values
    • Masking with Bit-Flag Measurements
      • How to Define Meanings on Measurements
      • How to Create Masks within code
  • Dataset Writing
  • Product Writing
  • Creating Geometries
    • datacube.utils.geometry.point
    • datacube.utils.geometry.multipoint
    • datacube.utils.geometry.line
    • datacube.utils.geometry.multiline
    • datacube.utils.geometry.polygon
    • datacube.utils.geometry.multipolygon
    • datacube.utils.geometry.multigeom
    • datacube.utils.geometry.box
    • datacube.utils.geometry.sides
    • datacube.utils.geometry.polygon_from_transform
  • Spatial Operations
    • datacube.utils.geometry.unary_union
    • datacube.utils.geometry.unary_intersection
    • datacube.utils.geometry.bbox_union
    • datacube.utils.geometry.bbox_intersection
    • datacube.utils.geometry.lonlat_bounds
    • datacube.utils.geometry.projected_lon
    • datacube.utils.geometry.clip_lon180
    • datacube.utils.geometry.chop_along_antimeridian
  • Utilities
    • datacube.utils.geometry.assign_crs
    • datacube.utils.geometry.crs_units_per_degree
    • datacube.utils.geometry.geobox_union_conservative
    • datacube.utils.geometry.geobox_intersection_conservative
    • datacube.utils.geometry.scaled_down_geobox
    • datacube.utils.geometry.intersects
    • datacube.utils.geometry.common_crs
    • datacube.utils.geometry.is_affine_st
    • datacube.utils.geometry.apply_affine
    • datacube.utils.geometry.roi_boundary
    • datacube.utils.geometry.roi_is_empty
    • datacube.utils.geometry.roi_is_full
    • datacube.utils.geometry.roi_intersect
    • datacube.utils.geometry.roi_shape
    • datacube.utils.geometry.roi_normalise
    • datacube.utils.geometry.roi_from_points
    • datacube.utils.geometry.roi_center
    • datacube.utils.geometry.roi_pad
    • datacube.utils.geometry.scaled_down_shape
    • datacube.utils.geometry.scaled_down_roi
    • datacube.utils.geometry.scaled_up_roi
    • datacube.utils.geometry.decompose_rws
    • datacube.utils.geometry.affine_from_pts
    • datacube.utils.geometry.get_scale_at_point
    • datacube.utils.geometry.native_pix_transform
    • datacube.utils.geometry.compute_reproject_roi
    • datacube.utils.geometry.split_translation
    • datacube.utils.geometry.compute_axis_overlap
    • datacube.utils.geometry.w_
    • datacube.utils.geometry.warp_affine
    • datacube.utils.geometry.rio_reproject
  • Amazon Web Services (AWS)
  • Writing GeoTIFFs
  • Dask
  • Grid Workflow
• About
  • What’s New
    • v1.8.next
    • v1.8.12 (7th March 2023)
    • v1.8.11 (6 February 2023)
    • v1.8.10 (30 January 2023)
      • Notes for 1.8.10
      • Full list of changes:
    • 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)
      • Virtual Products
      • Changes to Data Loading
      • Other Changes
      • Performance Improvements
      • Documentation Improvements
      • Deprecations
    • v1.6.1 (27 August 2018)
    • v1.6.0 (23 August 2018)
    • v1.6rc2 (29 June 2018)
      • Backwards Incompatible Changes
      • Changes
      • Bug Fixes
    • v1.6rc1 Easter Bilby (10 April 2018)
      • Backwards Incompatible Fixes
      • Enhancements
      • Bug Fixes
      • New Data Support
    • 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)
      • New Features
      • Usability Improvements
    • 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
  • Release Process