# spagheddieg/pynavcore architecture

> Architecture diagram of the GitHub repository spagheddieg/pynavcore, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/spagheddieg/pynavcore
- Repository: https://github.com/spagheddieg/pynavcore

## Overview

##### Project type and purpose
- This is an open-source, command-line–driven scientific/engineering tool written in Python, implementing a Single Point Positioning (SPP) solver for GNSS data (primarily GPS). It ingests RINEX observation and navigation files, computes satellite ephemerides and corrections, runs an iterative least-squares solver, then emits JSON results and optional visualizations.

##### File structure
- Top-level scripts:
- main.py – CLI entry point that ties everything together.
- spp_module.py – core solver library (parsing, ephemeris computation, corrections, solver).
- visualizer.py – plotting routines for position errors, pseudorange residuals, geometry, convergence.
- test.py – unit– or integration–test harness.
- Data files (example inputs): algo0010.25o and brdc0010.25n – RINEX observation and broadcast ephemeris.
- __pycache__ – compiled Python artifacts (ignore).
- No separate frontend/backend; it’s a single-process modular CLI application.

##### README for architectural insights
- Key modules implicitly described: RINEX parsing (georinex + xarray), ephemeris & clock correction, Sagnac correction, iterative least-squares solver, progress tracking (tqdm), JSON output, convergence logging, visualization.

## Diagram (Mermaid)

```mermaid
flowchart TD
    CLI["CLI / Orchestrator"]:::io
    CLI -->|invokes| Parser

    subgraph "Input Layer"
        Inputs(("Example Input Data<br>[algo0010.25o, brdc0010.25n]")):::data
        Parser["RINEX Parser"]:::core
        Inputs -->|reads| Parser
    end

    subgraph "Core Processing Pipeline"
        Parser -->|"parsed data"| Ephemeris["Ephemeris & Clock Correction"]:::core
        Ephemeris -->|"corrected measurements"| Sagnac["Earth-Rotation (Sagnac) Correction"]:::core
        Sagnac -->|"sagnac-corrected data"| Preprocessor["Satellite Selection & Pseudorange Preprocessor"]:::core
        Preprocessor -->|"preprocessed data"| Solver["Iterative Least-Squares Solver"]:::core
        Solver -->|"estimates"| Convergence["Convergence & Logging Component"]:::core
        Convergence -->|checks convergence| Solver
    end

    Convergence -->|"logged results"| Output["Output Writer"]:::io
    Output -->|"JSON files"| DataOut(("spp_results.json<br>spp_convergence_log.json")):::data

    subgraph "Visualization"
        Vis["Visualization Module"]:::io
        DataOut -->|optional| Vis
    end

    subgraph "Testing"
        Test["Test Harness"]:::io
        Test -->|invokes modules| Parser
        Test -->|invokes modules| Ephemeris
        Test -->|invokes modules| Solver
    end

    Doc["Project Documentation (README)"]:::external
    Doc -.-> Parser

    click CLI "https://github.com/spagheddieg/pynavcore/blob/main/main.py"
    click Parser "https://github.com/spagheddieg/pynavcore/blob/main/spp_module.py"
    click Ephemeris "https://github.com/spagheddieg/pynavcore/blob/main/spp_module.py"
    click Sagnac "https://github.com/spagheddieg/pynavcore/blob/main/spp_module.py"
    click Preprocessor "https://github.com/spagheddieg/pynavcore/blob/main/spp_module.py"
    click Solver "https://github.com/spagheddieg/pynavcore/blob/main/spp_module.py"
    click Convergence "https://github.com/spagheddieg/pynavcore/blob/main/spp_module.py"
    click Output "https://github.com/spagheddieg/pynavcore/blob/main/main.py"
    click Vis "https://github.com/spagheddieg/pynavcore/blob/main/visualizer.py"
    click Test "https://github.com/spagheddieg/pynavcore/blob/main/test.py"
    click Doc "https://github.com/spagheddieg/pynavcore/blob/main/readme.md"

    classDef core fill:#D0E6FF,stroke:#4A90E2,stroke-width:1px
    classDef io fill:#E6FFEA,stroke:#2ECC71,stroke-width:1px
    classDef data fill:#FFF4E6,stroke:#E67E22,stroke-width:1px,stroke-dasharray: 5 5
    classDef external fill:#F0F0F0,stroke:#7F8C8D,stroke-width:1px,stroke-dasharray: 2 2
```
