# andytorrestb/pyrpod architecture

> Architecture diagram of the GitHub repository andytorrestb/pyrpod, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/andytorrestb/pyrpod
- Repository: https://github.com/andytorrestb/pyrpod

## Overview

PyRPOD is a Python analysis toolkit for rendezvous, proximity operations, and docking. Its main case workflow loads vehicle geometry, mission environment, and jet-firing history, then estimates plume strikes and surface effects for analysis and visualization. Separate mission-planning and trade-study branches support fuel and dynamics calculations, parameter sweeps, load summaries, and comparison with external reference data. The graph follows documented entry points and SOURCE INDEX references; several internal call details and unsampled subsystems are not shown.

Main entry points: [`pyrpod/mdao/parameter_sweep.py`](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/parameter_sweep.py) (Parameter sweep), [`pyrpod/mdao/plume_validation.py`](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/plume_validation.py) (Plume validation), [`case/rpod/1d_approach/run.py`](https://github.com/andytorrestb/pyrpod/blob/master/case/rpod/1d_approach/run.py) (Case runner), [`pyrpod/mission/MissionPlanner.py`](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/MissionPlanner.py) (Mission planner)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_case["Case analysis"]
  node_case_run["Case runner<br/>[run.py]"]
  node_jfh["Jet firing history"]
  node_environment["Mission environment"]
  node_visiting_vehicle["Visiting vehicle<br/>[VisitingVehicle.py]"]
  node_target_vehicle["Target vehicle<br/>[TargetVehicle.py]"]
  node_logistics_module["Logistics module<br/>[LogisticsModule.py]"]
end

subgraph group_physics["Plume physics"]
  node_strike_study["Strike estimation"]
  node_plume_calculator["Strike calculator"]
  node_gas_kinetics["Gas kinetics"]
  node_cai_model["Cai impingement"]
end

subgraph group_mission["Mission planning"]
  node_mission_planner["Mission planner<br/>[MissionPlanner.py]"]
  node_fuel_manager["Fuel management<br/>[fuel_management.py]"]
  node_flight_eval["Flight evaluation<br/>[flight_eval.py]"]
  node_dynamics["6-DOF dynamics"]
  node_orbital_transfer["Orbital transfer"]
end

subgraph group_studies["Trade studies"]
  node_trade_study["Trade study API<br/>[TradeStudy.py]"]
  node_parameter_sweep["Parameter sweep<br/>[parameter_sweep.py]"]
  node_plume_validation["Plume validation"]
  node_study_config["Study configuration<br/>[study_config.py]"]
  node_study_results["Study results<br/>[study_results.py]"]
  node_reference_data["Reference comparison<br/>[reference_data.py]"]
  node_surface_loads["Surface loads<br/>[surface_loads.py]"]
  node_firing_plan["Firing plan<br/>[firing_plan.py]"]
  node_study_runtime["Study runtime<br/>[study_runtime.py]"]
  node_study_plots["Study plots<br/>[study_plots.py]"]
end

subgraph group_shared["Shared services"]
  node_mesh_tools["STL and VTK tools<br/>[stl.py]"]
  node_asset_paths["Asset paths<br/>[fs.py]"]
  node_logging["Operational logging<br/>[logging_utils.py]"]
end

node_engineer(("Engineer"))
node_reference_service["Reference datasets"]

node_engineer -->|"starts case"| node_case_run
node_case_run -->|"loads history"| node_jfh
node_case_run -->|"sets up"| node_environment
node_case_run -->|"runs analysis"| node_strike_study
node_environment -->|"creates"| node_jfh
node_environment -->|"creates"| node_visiting_vehicle
node_environment -->|"creates"| node_target_vehicle
node_strike_study -->|"uses model"| node_gas_kinetics
node_strike_study -->|"uses calculator"| node_plume_calculator
node_cai_model -->|"uses kinetics"| node_gas_kinetics
node_strike_study -->|"uses mesh tools"| node_mesh_tools
node_trade_study -->|"loads configuration"| node_study_config
node_trade_study -->|"selects engine"| node_parameter_sweep
node_trade_study -->|"selects engine"| node_plume_validation
node_parameter_sweep -->|"uses plan"| node_firing_plan
node_parameter_sweep -->|"uses runtime"| node_study_runtime
node_parameter_sweep -->|"writes results"| node_study_results
node_parameter_sweep -->|"creates plots"| node_study_plots
node_plume_validation -->|"uses plan"| node_firing_plan
node_plume_validation -->|"uses runtime"| node_study_runtime
node_plume_validation -->|"writes results"| node_study_results
node_plume_validation -->|"creates plots"| node_study_plots
node_study_results -->|"uses load calculations"| node_surface_loads
node_trade_study -->|"compares results"| node_reference_data
node_reference_data -->|"reads reference data"| node_reference_service
node_mission_planner -->|"uses fuel management"| node_fuel_manager
node_mission_planner -->|"uses evaluation"| node_flight_eval
node_mission_planner -->|"uses dynamics"| node_dynamics
node_mission_planner -->|"uses transfer"| node_orbital_transfer
node_visiting_vehicle -->|"uses mesh tools"| node_mesh_tools
node_target_vehicle -->|"resolves geometry"| node_asset_paths
node_logging -->|"configured by case"| node_case_run

click node_case_run "https://github.com/andytorrestb/pyrpod/blob/master/case/rpod/1d_approach/run.py"
click node_jfh "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/rpod/JetFiringHistory.py"
click node_environment "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/MissionEnvironment.py"
click node_visiting_vehicle "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/vehicle/VisitingVehicle.py"
click node_target_vehicle "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/vehicle/TargetVehicle.py"
click node_logistics_module "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/vehicle/LogisticsModule.py"
click node_strike_study "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/rpod/PlumeStrikeEstimationStudy.py"
click node_plume_calculator "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/plume/PlumeStrikeCalculator.py"
click node_gas_kinetics "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/plume/RarefiedPlumeGasKinetics.py"
click node_cai_model "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/plume/CaiImpingement2016.py"
click node_mission_planner "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/MissionPlanner.py"
click node_fuel_manager "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/fuel_management.py"
click node_flight_eval "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/flight_eval.py"
click node_dynamics "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/six_dof_dynamics.py"
click node_orbital_transfer "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/orbital_transfer.py"
click node_trade_study "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/TradeStudy.py"
click node_parameter_sweep "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/parameter_sweep.py"
click node_plume_validation "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/plume_validation.py"
click node_study_config "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/study_config.py"
click node_study_results "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/study_results.py"
click node_reference_data "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/reference_data.py"
click node_surface_loads "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/surface_loads.py"
click node_firing_plan "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/firing_plan.py"
click node_study_runtime "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/study_runtime.py"
click node_study_plots "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/study_plots.py"
click node_mesh_tools "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/util/stl/stl.py"
click node_asset_paths "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/util/io/fs.py"
click node_logging "https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/logging_utils.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_case_run,node_jfh,node_environment,node_visiting_vehicle,node_target_vehicle,node_logistics_module toneBlue
class node_strike_study,node_plume_calculator,node_gas_kinetics,node_cai_model toneAmber
class node_mission_planner,node_fuel_manager,node_flight_eval,node_dynamics,node_orbital_transfer toneMint
class node_trade_study,node_parameter_sweep,node_plume_validation,node_study_config,node_study_results,node_reference_data,node_surface_loads,node_firing_plan,node_study_runtime,node_study_plots toneRose
class node_mesh_tools,node_asset_paths,node_logging,node_engineer,node_reference_service toneIndigo
```

## Components

### Case analysis

- [Case runner](https://github.com/andytorrestb/pyrpod/blob/master/case/rpod/1d_approach/run.py): `case/rpod/1d_approach/run.py`
- [Jet firing history](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/rpod/JetFiringHistory.py): `pyrpod/rpod/JetFiringHistory.py`
- [Mission environment](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/MissionEnvironment.py): `pyrpod/mission/MissionEnvironment.py`
- [Visiting vehicle](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/vehicle/VisitingVehicle.py): `pyrpod/vehicle/VisitingVehicle.py`
- [Target vehicle](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/vehicle/TargetVehicle.py): `pyrpod/vehicle/TargetVehicle.py`
- [Logistics module](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/vehicle/LogisticsModule.py): `pyrpod/vehicle/LogisticsModule.py`

### Plume physics

- [Strike estimation](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/rpod/PlumeStrikeEstimationStudy.py): `pyrpod/rpod/PlumeStrikeEstimationStudy.py`
- [Strike calculator](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/plume/PlumeStrikeCalculator.py): `pyrpod/plume/PlumeStrikeCalculator.py`
- [Gas kinetics](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/plume/RarefiedPlumeGasKinetics.py): `pyrpod/plume/RarefiedPlumeGasKinetics.py`
- [Cai impingement](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/plume/CaiImpingement2016.py): `pyrpod/plume/CaiImpingement2016.py`

### Mission planning

- [Mission planner](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/MissionPlanner.py): `pyrpod/mission/MissionPlanner.py`
- [Fuel management](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/fuel_management.py): `pyrpod/mission/fuel_management.py`
- [Flight evaluation](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/flight_eval.py): `pyrpod/mission/flight_eval.py`
- [6-DOF dynamics](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/six_dof_dynamics.py): `pyrpod/mission/six_dof_dynamics.py`
- [Orbital transfer](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mission/orbital_transfer.py): `pyrpod/mission/orbital_transfer.py`

### Trade studies

- [Trade study API](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/TradeStudy.py): `pyrpod/mdao/TradeStudy.py`
- [Parameter sweep](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/parameter_sweep.py): `pyrpod/mdao/parameter_sweep.py`
- [Plume validation](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/plume_validation.py): `pyrpod/mdao/plume_validation.py`
- [Study configuration](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/study_config.py): `pyrpod/mdao/study_config.py`
- [Study results](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/study_results.py): `pyrpod/mdao/study_results.py`
- [Reference comparison](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/reference_data.py): `pyrpod/mdao/reference_data.py`
- [Surface loads](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/surface_loads.py): `pyrpod/mdao/surface_loads.py`
- [Firing plan](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/firing_plan.py): `pyrpod/mdao/firing_plan.py`
- [Study runtime](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/study_runtime.py): `pyrpod/mdao/study_runtime.py`
- [Study plots](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/mdao/study_plots.py): `pyrpod/mdao/study_plots.py`

### Shared services

- [STL and VTK tools](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/util/stl/stl.py): `pyrpod/util/stl/stl.py`
- [Asset paths](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/util/io/fs.py): `pyrpod/util/io/fs.py`
- [Operational logging](https://github.com/andytorrestb/pyrpod/blob/master/pyrpod/logging_utils.py): `pyrpod/logging_utils.py`

### Other components

- **Engineer**
- **Reference datasets**

## Connections

- Engineer → Case runner: starts case (evidence: `README.md`)
- Case runner → Jet firing history: loads history (evidence: `case/rpod/1d_approach/run.py`)
- Case runner → Mission environment: sets up (evidence: `case/rpod/1d_approach/run.py`)
- Case runner → Strike estimation: runs analysis (evidence: `case/rpod/1d_approach/run.py`)
- Mission environment → Jet firing history: creates (evidence: `pyrpod/mission/MissionEnvironment.py`)
- Mission environment → Visiting vehicle: creates (evidence: `pyrpod/mission/MissionEnvironment.py`)
- Mission environment → Target vehicle: creates (evidence: `pyrpod/mission/MissionEnvironment.py`)
- Strike estimation → Gas kinetics: uses model (evidence: `pyrpod/rpod/PlumeStrikeEstimationStudy.py`)
- Strike estimation → Strike calculator: uses calculator (evidence: `pyrpod/rpod/PlumeStrikeEstimationStudy.py`)
- Cai impingement → Gas kinetics: uses kinetics (evidence: `pyrpod/plume/CaiImpingement2016.py`)
- Strike estimation → STL and VTK tools: uses mesh tools (evidence: `pyrpod/rpod/PlumeStrikeEstimationStudy.py`)
- Trade study API → Study configuration: loads configuration (evidence: `pyrpod/mdao/TradeStudy.py`)
- Trade study API → Parameter sweep: selects engine (evidence: `pyrpod/mdao/TradeStudy.py`)
- Trade study API → Plume validation: selects engine (evidence: `pyrpod/mdao/TradeStudy.py`)
- Parameter sweep → Firing plan: uses plan (evidence: `pyrpod/mdao/parameter_sweep.py`)
- Parameter sweep → Study runtime: uses runtime (evidence: `pyrpod/mdao/parameter_sweep.py`)
- Parameter sweep → Study results: writes results (evidence: `pyrpod/mdao/parameter_sweep.py`)
- Parameter sweep → Study plots: creates plots (evidence: `pyrpod/mdao/parameter_sweep.py`)
- Plume validation → Firing plan: uses plan (evidence: `pyrpod/mdao/plume_validation.py`)
- Plume validation → Study runtime: uses runtime (evidence: `pyrpod/mdao/plume_validation.py`)
- Plume validation → Study results: writes results (evidence: `pyrpod/mdao/plume_validation.py`)
- Plume validation → Study plots: creates plots (evidence: `pyrpod/mdao/plume_validation.py`)
- Study results → Surface loads: uses load calculations (evidence: `pyrpod/mdao/study_results.py`)
- Trade study API → Reference comparison: compares results (evidence: `pyrpod/mdao/TradeStudy.py`)
- Reference comparison → Reference datasets: reads reference data (evidence: `README.md`)
- Mission planner → Fuel management: uses fuel management (evidence: `pyrpod/mission/MissionPlanner.py`)
- Mission planner → Flight evaluation: uses evaluation (evidence: `pyrpod/mission/MissionPlanner.py`)
- Mission planner → 6-DOF dynamics: uses dynamics (evidence: `pyrpod/mission/MissionPlanner.py`)
- Mission planner → Orbital transfer: uses transfer (evidence: `pyrpod/mission/MissionPlanner.py`)
- Visiting vehicle → STL and VTK tools: uses mesh tools (evidence: `pyrpod/vehicle/VisitingVehicle.py`)
- Target vehicle → Asset paths: resolves geometry (evidence: `pyrpod/vehicle/TargetVehicle.py`)
- Operational logging → Case runner: configured by case (evidence: `README.md`)
