# li-cor-environmental/eddypro-engine architecture

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

- Interactive diagram: https://gitdiagram.com/li-cor-environmental/eddypro-engine
- Repository: https://github.com/li-cor-environmental/eddypro-engine

## Overview

##### Project type and purpose
- This is the “EddyPro Engine,” a command-line, Fortran-based open-source application for processing eddy covariance data. It computes fluxes (H₂O, CO₂, CH₄, energy, etc.) via two main processing pipelines (RP and FCC). A separate GUI repository exists, but this tree is the engine itself.

##### File structure
- Top level:
- prj/Makefile and scripts to build two executables: “rp” (run processing) and “fcc” (frequency correction chain).
- src/: three subdirectories:
– src_common/: core Fortran modules and utilities shared by both pipelines (I/O, statistics, metadata, math, file handling, exception handling).
– src_rp/: modules implementing the “Run Processing (RP)” workflow—time-lag correction, statistical tests, flux computation, biomet data integration, output routines.
– src_fcc/: modules implementing the “Frequency Correction Chain (FCC)” workflow—spectral analysis, cospectral modeling, correction functions, output routines.
- No traditional frontend/backend split; it’s a monolithic CLI engine organized into modular pipelines built and invoked via Makefile.

##### Insights from README
- Two independent processing modes (RP and FCC).
- Build instructions: gfortran, prj/Makefile target “make rp” and “make fcc.”
- Dependencies: Fortran compiler, shell scripts, 7-Zip and pausep utilities in bin/.

##### Elements
- Clear labels on each block (e.g., “Configuration Parser,” “Common Core,” “RP Pipeline”)
- From CLI to Config → Core → Pipeline → Output
- From Pipeline back to Core for shared utilities
- CLI (e.g., green)
- Shared modules (blue)
- RP modules (orange)
- FCC modules (yellow)
- External utilities (gray)
- File system/external data (brown)

##### Detailed capture of essential elements
- src_common/ as a library block subdivided into I/O, Math, Statistics, Exception Handling
- src_rp/ and src_fcc/ as separate pipeline blocks showing major functional groupings (e.g., “Time-lag correction,” “Statistical tests,” “Spectral analysis,” “Model fitting”)
- prj/Makefile and build scripts as the “Build & Deployment” block
- External utilities as side‐blocks called by the pipelines

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build & Deployment
    Build["Build & Deployment"]:::build
    Build -->|build targets| RPMain
    Build -->|build targets| FCCMain

    %% CLI Launchers
    subgraph "CLI Launchers"
        RPMain["RP Mode Launcher\needdypro-rp_main.f90"]:::cli
        FCCMain["FCC Mode Launcher\needdypro-fcc_main.f90"]:::cli
    end

    RPMain -->|invokes| ConfigParser
    FCCMain -->|invokes| ConfigParser

    %% Configuration & Parameter Parser
    subgraph "Configuration Parser" 
        ParseINI["Parse INI File"]:::common
        EditINI["Edit INI File"]:::common
        ConfigParser["Config Parser"]:::common
    end

    ConfigParser -->|uses| ParseINI
    ConfigParser -->|uses| EditINI
    RPMain -->|reads config via| ConfigRP
    FCCMain -->|reads config via| ConfigFCC

    %% Configuration Readers
    ConfigRP["Read INI for RP"]:::common
    ConfigFCC["Read INI for FCC"]:::common

    RPMain -->|->| ConfigRP
    FCCMain -->|->| ConfigFCC

    %% Common Core Library
    subgraph "Common Core Library" 
        CoreIO["I/O Modules"]:::common
        CoreMath["Math Modules"]:::common
        CoreStats["Statistics Modules"]:::common
        CoreUtil["Utilities & Exceptions"]:::common
    end

    ConfigParser -->|initializes| CoreIO
    ConfigParser -->|initializes| CoreMath
    ConfigParser -->|initializes| CoreStats
    ConfigParser -->|initializes| CoreUtil

    %% RP Pipeline
    subgraph "RP Pipeline" 
        RPImport["Data Import"]:::rp
        RPLag["Time-lag Correction"]:::rp
        RPTests["Statistical Tests"]:::rp
        RPFlux["Flux Computation"]:::rp
        RPBio["Biomet Integration"]:::rp
        RPOut["Output Modules"]:::rp
    end

    RPMain -->|calls| RPImport
    RPImport --> RPLag
    RPLag --> RPTests
    RPTests --> RPFlux
    RPFlux --> RPBio
    RPBio --> RPOut
    RPOut -->|writes| FileSystem

    %% FCC Pipeline
    subgraph "FCC Pipeline" 
        FCCImport["Spectral Analysis"]:::fcc
        FCCModel["Cospectral Modeling"]:::fcc
        FCCCorr["Correction Functions"]:::fcc
        FCCOut["Output Modules"]:::fcc
    end

    FCCMain -->|calls| FCCImport
    FCCImport --> FCCModel
    FCCModel --> FCCCorr
    FCCCorr --> FCCOut
    FCCOut -->|writes| FileSystem

    %% Core interactions
    RPImport ---|uses| CoreIO
    RPLag ---|uses| CoreMath
    RPTests ---|uses| CoreStats
    RPFlux ---|uses| CoreMath
    RPBio ---|uses| CoreIO
    RPOut ---|uses| CoreIO

    FCCImport ---|uses| CoreMath
    FCCModel ---|uses| CoreMath
    FCCCorr ---|uses| CoreMath
    FCCOut ---|uses| CoreIO

    %% External Utilities
    subgraph "External Utilities" 
        SevenZip["7-Zip Utility"]:::external
        Pausep["pausep Utility"]:::external
    end

    RPMain -->|executes| SevenZip
    RPMain -->|executes| Pausep
    FCCMain -->|executes| SevenZip
    FCCMain -->|executes| Pausep

    %% File System / Data Stores
    FileSystem["File System\n(raw data, metadata, outputs)"]:::fs

    %% Click Events
    click RPMain "https://github.com/li-cor-environmental/eddypro-engine/blob/master/src/src_rp/eddypro-rp_main.f90"
    click FCCMain "https://github.com/li-cor-environmental/eddypro-engine/blob/master/src/src_fcc/eddypro-fcc_main.f90"
    click ParseINI "https://github.com/li-cor-environmental/eddypro-engine/blob/master/src/src_common/parse_ini_file.f90"
    click EditINI "https://github.com/li-cor-environmental/eddypro-engine/blob/master/src/src_common/edit_ini_file.f90"
    click ConfigRP "https://github.com/li-cor-environmental/eddypro-engine/blob/master/src/src_rp/read_ini_rp.f90"
    click ConfigFCC "https://github.com/li-cor-environmental/eddypro-engine/blob/master/src/src_fcc/read_ini_fcc.f90"
    click CommonCore "https://github.com/li-cor-environmental/eddypro-engine/tree/master/src/src_common/"
    click RPModules "https://github.com/li-cor-environmental/eddypro-engine/tree/master/src/src_rp/"
    click FCCModules "https://github.com/li-cor-environmental/eddypro-engine/tree/master/src/src_fcc/"
    click Makefile "https://github.com/li-cor-environmental/eddypro-engine/tree/master/prj/Makefile"
    click VersionScript "https://github.com/li-cor-environmental/eddypro-engine/blob/master/prj/current_date_and_version_as_parameters.sh"

    %% Styles
    classDef build fill:#DDA0DD,stroke:#800080,color:#000;
    classDef cli fill:#98FB98,stroke:#008000,color:#000;
    classDef common fill:#ADD8E6,stroke:#0000FF,color:#000;
    classDef rp fill:#FFA500,stroke:#FF8C00,color:#000;
    classDef fcc fill:#FFFF99,stroke:#CCCC00,color:#000;
    classDef external fill:#D3D3D3,stroke:#A9A9A9,color:#000;
    classDef fs fill:#DEB887,stroke:#A0522D,color:#000;
```
