# tomojitakasu/rtklib architecture

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

- Interactive diagram: https://gitdiagram.com/tomojitakasu/rtklib
- Repository: https://github.com/tomojitakasu/rtklib

## Overview

##### Project Type and Purpose
- RTKLIB is an open‐source GNSS positioning toolset:
- A cross‐platform ANSI C/C++ core library implementing satellite navigation algorithms (RTK, PPP, post‐processing)
- A suite of command‐line (CUI) and GUI applications that drive the library for real‐time and offline workflows
- Utilities, sample data, tests and documentation in one monolithic repository

##### High‐Level Components
A. Core Library (src, lib)
– Algorithm modules: positioning (rtkcmn.c, pntpos.c, postpos.c, ppp.c, ppp_ar.c, etc.)
– Data format parsers/writers: RINEX (rinex.c), RTCM (rtcm*.c), BINEX, SP3, ANTEX, IONEX, etc.
– Receiver interfaces: code in src/rcv for proprietary GNSS raw messages (ublox, novatel, septentrio, etc.)
– Utility modules: coordinate transforms, time/string functions, matrix/vector, atmosphere and antenna models
– Platform abstractions: serial/TCP/I/O threads (stream.c, streamsvr.c), Win32 vs. POSIX sockets

B. Application Layer
1. Command‐Line APs (app/* CUI)
- rtkrcv (real‐time positioning server)
- rnx2rtkp (post‐processing kinematic/PPP)
- strsvr, str2str (stream server/client)
- convbin, pos2kml (data converters)
2. GUI APs (app/* GUI, C++)
- rtknavi (real‐time GUI navigator)
- rtkpost (post‐processing GUI)
- rtkplot (plot solutions & obs data)
- rtkconv (RINEX converter GUI)
- rtkget (downloader)
- srctblbrows (NTRIP browser)
- rtklaunch (application launcher)

C. Utilities (util/)
– Data generators, test pattern creators (gencrc, geniono, simobs, etc.)
– Geoid and grid tools, conversion scripts

D. Sample Data & Test Suite
– data/ : sample GNSS observations, navigation files, TLEs, station lists
– test/data & test/utest : unit‐tests, MATLAB/Octave scripts, test binaries

E. Build & Packaging
– app/* contains IDE project files (Borland C++ Builder, makefiles) for all APs
– lib/* contains build scripts for core library (gcc, bcc, msc, MKL/LAPACK options)
– bin/ includes prebuilt Windows executables and DLLs
– doc/ holds manuals and release notes

##### Relationships and Data Flow
- External GNSS data sources (serial ports, TCP streams, NTRIP) → Stream modules (stream.c, strsvr)
- Raw data → Receiver parsers (src/rcv/*.c) → Universal observation structures
- Observation + navigation data (RINEX, SP3, ANTEX) → Positioning engine (ppp.c, rtkpos.c)
- Computation results → Applications (GUI/CUI) for display, logging, file output, or further streaming
- Configuration & Options (options.c, GUI dialogs) → Library parameterization

##### Architectural Patterns & Design Principles
- Modular layering: clear separation of I/O, parsing, core algorithms, and application logic
- Plug‐in-like receiver drivers (each file in src/rcv is self‐contained)
- Data‐driven workflows: APs act as orchestration layers over library functions
- Cross‐platform abstractions: compile‐time flags select Win32 vs. POSIX threading/sockets
- Extensibility: utilities and test code demonstrate integration points for new data formats or algorithms

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Interfaces
    subgraph "External Interfaces"
        direction TB
        SP[/"Serial Port"/]:::external
        TCP[/"TCP/IP Stream"/]:::external
        NTRIP[/"NTRIP Server"/]:::external
    end

    %% Core Library
    subgraph "Core Library" 
        direction TB
        IO["I/O Modules"]:::core
        click IO "https://github.com/tomojitakasu/rtklib/blob/master/src/stream.c"
        Parsers["RINEX/RTCM Parsers"]:::core
        click Parsers "https://github.com/tomojitakasu/rtklib/blob/master/src/rinex.c"
        RecPars["Receiver Parsers"]:::core
        click RecPars "https://github.com/tomojitakasu/rtklib/tree/master/src/rcv/"
        Algos["Positioning Engine"]:::core
        click Algos "https://github.com/tomojitakasu/rtklib/blob/master/src/rtkcmn.c"
        Utils["Utility Modules"]:::core
        click Utils "https://github.com/tomojitakasu/rtklib/blob/master/src/options.c"
        API["RTKLIB API (rtklib.h)"]:::core
        click API "https://github.com/tomojitakasu/rtklib/blob/master/src/rtklib.h"
    end

    %% Data Stores
    subgraph "Data Stores"
        direction TB
        SampleData[(Sample Data)]:::data
        click SampleData "https://github.com/tomojitakasu/rtklib/tree/master/data/"
        TestData[(Test Data)]:::data
        click TestData "https://github.com/tomojitakasu/rtklib/tree/master/test/data/"
        Config[(Config Files)]:::data
    end

    %% Applications
    subgraph "CUI Applications" 
        direction TB
        RTKRCV["rtkrcv"]:::cui
        click RTKRCV "https://github.com/tomojitakasu/rtklib/blob/master/app/rtkrcv/rtkrcv.c"
        RNX2["rnx2rtkp"]:::cui
        click RNX2 "https://github.com/tomojitakasu/rtklib/blob/master/app/rnx2rtkp/rnx2rtkp.c"
        STR2["str2str"]:::cui
        click STR2 "https://github.com/tomojitakasu/rtklib/blob/master/app/str2str/str2str.c"
        STRSVR["strsvr"]:::cui
        click STRSVR "https://github.com/tomojitakasu/rtklib/blob/master/app/strsvr/strsvr.cpp"
        CONVBIN["convbin"]:::cui
        click CONVBIN "https://github.com/tomojitakasu/rtklib/blob/master/app/convbin/convbin.c"
        POS2KML["pos2kml"]:::cui
        click POS2KML "https://github.com/tomojitakasu/rtklib/blob/master/app/pos2kml/pos2kml.c"
    end

    subgraph "GUI Applications"
        direction TB
        RTKNAVI["rtknavi"]:::gui
        click RTKNAVI "https://github.com/tomojitakasu/rtklib/blob/master/app/rtknavi/rtknavi.cpp"
        RTKPOST["rtkpost"]:::gui
        click RTKPOST "https://github.com/tomojitakasu/rtklib/blob/master/app/rtkpost/rtkpost.cpp"
        RTKPLOT["rtkplot"]:::gui
        click RTKPLOT "https://github.com/tomojitakasu/rtklib/blob/master/app/rtkplot/rtkplot.cpp"
        RTKCONV["rtkconv"]:::gui
        click RTKCONV "https://github.com/tomojitakasu/rtklib/blob/master/app/rtkconv/rtkconv.cpp"
        RTKGET["rtkget"]:::gui
        click RTKGET "https://github.com/tomojitakasu/rtklib/blob/master/app/rtkget/rtkget.cpp"
        BROWS["srctblbrows"]:::gui
        click BROWS "https://github.com/tomojitakasu/rtklib/blob/master/app/srctblbrows/srctblbrows.cpp"
        LAUNCH["rtklaunch"]:::gui
        click LAUNCH "https://github.com/tomojitakasu/rtklib/blob/master/app/rtklaunch/rtklaunch.cpp"
    end

    %% Utilities & Test Suite
    subgraph "Utilities & Test Suite"
        direction TB
        UtilsApp["Utilities"]:::util
        click UtilsApp "https://github.com/tomojitakasu/rtklib/tree/master/util/"
        UnitTest["Unit Tests"]:::util
        click UnitTest "https://github.com/tomojitakasu/rtklib/tree/master/test/utest/"
    end

    %% Data Flow
    SP --> IO
    TCP --> IO
    NTRIP --> IO
    IO --> Parsers
    Parsers --> Algos
    RecPars --> Algos
    Algos --> API
    API --> RTKRCV
    API --> RNX2
    API --> STR2
    API --> STRSVR
    API --> CONVBIN
    API --> POS2KML
    API --> RTKNAVI
    API --> RTKPOST
    API --> RTKPLOT
    API --> RTKCONV
    API --> RTKGET
    API --> BROWS
    API --> LAUNCH
    SampleData --> Parsers
    TestData --> UnitTest
    UtilsApp --> API

    %% Outputs
    RTKRCV -->|"file/stream output"| SampleData
    RNX2 -->|"file output"| SampleData
    STR2 -->|"stream output"| NTRIP
    STRSVR -->|"stream server"| TCP
    CONVBIN -->|"converted files"| SampleData
    POS2KML -->|"KML output"| SampleData
    GUI -->|"GUI display"| Config

    %% Styles
    classDef core fill:#BBDEFB,stroke:#0D47A1,color:#0D47A1;
    classDef cui fill:#C8E6C9,stroke:#1B5E20,color:#1B5E20;
    classDef gui fill:#FFE0B2,stroke:#E65100,color:#E65100;
    classDef util fill:#ECEFF1,stroke:#546E7A,color:#546E7A;
    classDef data fill:#FFF9C4,stroke:#F57F17,color:#F57F17;
    classDef external fill:#E1F5FE,stroke:#01579B,color:#01579B;
```
