rms-metadata-tools

User Guide

  • User Guide

Developer Guide

  • Developer Guide
    • Introduction
    • Repository layout
    • Environment setup
    • Architecture
    • Index table subsystem
    • Geometry table subsystem
    • Cumulative table subsystem
    • Shared support
    • Extending the system
    • Coding conventions
    • API Reference
      • Core and support
      • Index table support
      • Geometry table support
      • Cumulative table support
      • Geometry column definitions

Project

  • Contributing
  • Contributor Covenant Code of Conduct
rms-metadata-tools
  • Developer Guide
  • API Reference
  • View page source

API Reference

This reference is generated from the docstrings of the importable metadata_tools package. It covers the host-agnostic engine: the modules that build index, geometry, and cumulative tables and their PDS3 labels. The per-host configuration packages under metadata_tools.hosts are example and configuration code rather than a stable import surface, and are documented in prose in Extending the system.

  • Core and support
    • metadata_tools
    • metadata_tools.common
    • metadata_tools.label_support
    • metadata_tools.util
    • metadata_tools.defs
    • metadata_tools.bodies
  • Index table support
    • IndexTable
    • get_args()
    • key__file_specification_name()
    • key__volume_id()
    • process_index()
  • Geometry table support
    • metadata_tools.geometry_support
    • metadata_tools.geometry_support.process
    • metadata_tools.geometry_support.suite
    • metadata_tools.geometry_support.record
    • metadata_tools.geometry_support.tables
    • metadata_tools.geometry_support.prep
    • metadata_tools.geometry_support.masks
    • metadata_tools.geometry_support.formatting
    • metadata_tools.geometry_support.formats
    • metadata_tools.geometry_support.bodies_select
  • Cumulative table support
    • create_cumulative_indexes()
    • get_args()
  • Geometry column definitions
    • metadata_tools.columns
    • metadata_tools.columns.body
    • metadata_tools.columns.ring
    • metadata_tools.columns.sky
    • metadata_tools.columns.sun
Previous Next

© Copyright 2025, SETI Institute.

Built with Sphinx using a theme provided by Read the Docs.