# ssc-maire/cosraymodifiediso architecture

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

- Interactive diagram: https://gitdiagram.com/ssc-maire/cosraymodifiediso
- Repository: https://github.com/ssc-maire/cosraymodifiediso

## Overview

##### Data Flow and Interactions

a. Primary Workflows:
- External Input → Core Module → Spectrum Output
- Time/Date Input → OULU Data → Solar Modulation → Spectrum Calculation
- Direct W-Parameter Input → Spectrum Calculation

b. Secondary Flows:
- Energy/Rigidity Conversion Paths
- Data Validation and Processing Paths

##### Key Integration Points

Interfaces for:
- Timestamp-based calculations
- Direct solar modulation parameter input
- OULU neutron monitor data integration
- Energy/Rigidity conversion utilities

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Input
        TS[Timestamps]
        WP[W-Parameters]
        PP[Particle Properties]
        direction TB
    end

    subgraph "Core Module"
        CosRay["CosRayModifiedISO.py"]:::core
    end

    subgraph "Internal Functions"
        direction TB
        Import["importingNMdata.py"]:::module
        ISO["pythonModifiedISO.py"]:::module
        Physics["rigidityEnergyConversionFunctions.py"]:::module
        Spectrum["spectrumHandling.py"]:::module
        Misc["miscellaneous.py"]:::module
    end

    subgraph "Data Storage"
        OULU["OULUinputData.pkl"]:::data
    end

    subgraph "Testing"
        Test["test_DLRISOmodel.py"]:::test
    end

    subgraph Output
        direction TB
        DEF[Differential Energy Fluxes]
        DRF[Differential Rigidity Fluxes]
        DF[Pandas DataFrames]
        CR[Conversion Results]
    end

    %% Connections
    TS --> CosRay
    WP --> CosRay
    PP --> CosRay

    CosRay --> Import
    CosRay --> ISO
    CosRay --> Physics
    CosRay --> Spectrum
    CosRay --> Misc

    Import --> OULU
    
    ISO --> DEF
    ISO --> DRF
    Physics --> CR
    Spectrum --> DF

    Test -.-> CosRay

    %% Click Events
    click CosRay "https://github.com/ssc-maire/CosRayModifiedISO/blob/master/CosRayModifiedISO/CosRayModifiedISO.py"
    click Import "https://github.com/ssc-maire/CosRayModifiedISO/blob/master/CosRayModifiedISO/internalFunctions/importingNMdata.py"
    click ISO "https://github.com/ssc-maire/CosRayModifiedISO/blob/master/CosRayModifiedISO/internalFunctions/pythonModifiedISO.py"
    click Physics "https://github.com/ssc-maire/CosRayModifiedISO/blob/master/CosRayModifiedISO/internalFunctions/rigidityEnergyConversionFunctions.py"
    click Spectrum "https://github.com/ssc-maire/CosRayModifiedISO/blob/master/CosRayModifiedISO/internalFunctions/spectrumHandling.py"
    click Misc "https://github.com/ssc-maire/CosRayModifiedISO/blob/master/CosRayModifiedISO/internalFunctions/miscellaneous.py"
    click OULU "https://github.com/ssc-maire/CosRayModifiedISO/blob/master/CosRayModifiedISO/neutronMonitorData/OULUinputData.pkl"
    click Test "https://github.com/ssc-maire/CosRayModifiedISO/blob/master/tests/test_DLRISOmodel.py"

    %% Styles
    classDef core fill:#f9f,stroke:#333,stroke-width:2px
    classDef module fill:#bbf,stroke:#333,stroke-width:1px
    classDef data fill:#dfd,stroke:#333,stroke-width:1px
    classDef test fill:#fdd,stroke:#333,stroke-width:1px

    %% Legend
    subgraph Legend
        L1[Core Module]:::core
        L2[Internal Functions]:::module
        L3[Data Storage]:::data
        L4[Testing]:::test
    end
```
