Developer Guide

This guide is intended for developers who want to understand, modify, or extend the RMS-NAV system.

Developer Guide Contents:

• Introduction
  • System Architecture
• Class Hierarchy
  • Key Components
• Navigation models
  • Stars
  • Bodies
  • Rings
  • Titan
• Correlation navigation technique
  • Overview
  • Pyramid correlation
  • Star position refinement
• Reprojection Internals
  • Module layout
  • Thread safety
  • Body mosaic storage
  • Ring sparse storage
  • Ring radius and longitude semantics
  • dtype propagation
  • Serialization
  • Photometric models
  • Context managers
  • Adding a new photometric model
  • Cartographic model projection
  • Command-line layer
  • Display layer
• Extending the System
  • Adding a New Dataset
  • Implementing PDS4 Bundle Generation Methods
  • Adding a New Instrument
  • Adding a New Navigation Model
  • Adding a New Navigation Technique
• Configuration System
  • Using Config directly
  • Configuration sections
• Best Practices
  • Code style
  • Linting and typing
  • Testing
  • Documentation
• Building the Documentation
  • Prerequisites
  • Building HTML Documentation
  • Building Other Formats
  • Working with Mermaid Diagrams
  • Updating API Documentation
  • Troubleshooting
• Backplanes
  • Modules
  • Snapshot Helpers
  • CLI and Roots
  • Configuration
  • Testing