User Guide

This guide explains how to install rms-metadata-tools and use it to generate PDS3 index, geometry, and cumulative metadata tables (and their labels) for a planetary science data collection. It is written for someone fluent in Python and the command line who has not read the source.

• Overview
  • Purpose
  • Table kinds
  • Workflow
• Installation and setup
  • Supported Python versions
  • Prerequisites
  • Installation
  • Environment variables
  • Directory layout
  • Running the programs
• Configuration
  • Host configuration files
  • How table and label names are formed
• The index program
  • Synopsis
  • Positional arguments
  • Options
  • Example
  • Results
• The geometry program
  • Synopsis
  • Positional arguments
  • Options
  • Example
  • Results
• The cumulative program
  • Synopsis
  • Positional arguments
  • Options
  • Example
  • Results
• Distributed (cloud) runs
  • How it works
  • Local parallel runs
  • GCP runs
  • Task file schema
• Examples
  • End-to-end run for one collection
  • Quick smoke test
  • Generating only labels
  • Using the engine from Python
• Appendix: Supported hosts
  • Galileo SSI (GO_0xxx)