Developer Guide

This guide is for developers who modify, extend, build, test, or release rms-metadata-tools. It explains how the code is organized, how the pieces cooperate, and how to add support for new collections and new geometry columns. For installing and running the tool, see the User Guide.

• Introduction
  • Audience
  • What the package does
  • Runtime and key dependencies
  • Design in one sentence
• Repository layout
• Environment setup
  • Development checkout
  • Environment variables
  • Running the entry points
  • Running the tests
  • Linting, typing, and docs
  • CI/CD and release
  • Contribution workflow
• Architecture
  • Engine and host configuration
  • Table classes
  • Data flow
• Index table subsystem
  • Overview
  • Entry point and walk
  • IndexTable
  • The value-resolution contract
  • Formatting
  • API reference
• Geometry table subsystem
  • Overview
  • Entry point
  • Suite
  • Record and prep
  • Masks
  • Formatting and formats
  • The format-dictionary contract
  • Body selection
  • Important invariants
  • API reference
• Cumulative table subsystem
  • Overview
  • How it works
  • Invariants
  • API reference
• Shared support
  • Overview
  • common – base class, logging, and CLI
  • label_support – PDS3 labels
  • columns – geometry column definitions
  • bodies – the oops body registry
  • util and defs
  • Invariants
  • API reference
• Extending the system
  • Adding a new host
  • Adding an index column (key function)
  • Adding a geometry column
• Coding conventions
  • Paths
  • Logging
  • Python style and typing
  • Testing
  • Documentation
  • Git and dependencies
• API Reference
  • Core and support
  • Index table support
  • Geometry table support
  • Cumulative table support
  • Geometry column definitions