Installing and managing the Open Data Cube

This section contains information on setting up and managing the Open Data Cube.

Note

class

info

For people using an existing Open Data Cube, such as Digital Earth Australia, you are not required to know most of the information contained here. This material is designed for people wanting to set up a new Open Data Cube instance.

Setting up an Open Data Cube

• Mac OSX Developer Setup
  • Required software
  • Python and packages
    • Conda environment setup
  • Postgres testing database configuration
  • Verify it all works
• Ubuntu Developer Setup
  • Required software
  • Python and packages
    • Conda environment setup
  • Postgres testing database 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

Open Data Cube CLI

• 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

Configuring the ODC Database

• Database Setup
  • Install PostgreSQL
  • Create Database
  • Create Configuration File
  • Initialise the Database Schema
• Metadata Types
• Product Definitions
• Dataset Documents
  • EO3 Format
    • 3D dataset metadata
    • Time-stacked NetCDF files
  • EO (deprecated)

Indexing Data

• 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

Advanced Topics

• 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

Legacy Approaches

• Ingesting Data
  • Ingestion Configuration
  • Ingestion Config
  • Ingest Some Data