# rheopy/rheofit architecture

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

- Interactive diagram: https://gitdiagram.com/rheopy/rheofit
- Repository: https://github.com/rheopy/rheofit

## Overview

##### Main Components Identification

The system consists of these primary components:
- Core Library Components
- Data Input/Processing Layer
- Visualization Layer
- Interactive Interfaces
- Documentation System

##### Component Relationships

- Data flow from input files to core processing
- Integration between core modules
- Connection to visualization components
- Interface interactions with core functionality

##### Specific Elements

a) Core Components:
**[models.py] ←→ [rheodata.py] ←→ [visualization.py]**

b) Data Handling:
**[Input Files (.xls, .csv)] → [Data Processing] → [Core Components]**

c) Interactive Interfaces:
**[Jupyter Notebooks]**
**[Voila Apps]     → [Core Library]**
**[Binder/Colab]**

##### Technical Details to Highlight

- Python package structure
- Scientific computing dependencies
- Web-based deployment options
- Data format support

Keep the abstraction level focused on the main architectural components while showing enough detail to understand the data flow and processing pipeline for rheological analysis.

This architecture should clearly show how the system supports both local development and cloud-based deployment options, making it accessible for different user scenarios.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Core Library Layer"
        Models["Models"]:::core
        DataProc["Data Processing"]:::core
        Viz["Visualization"]:::core
        
        Models <--> DataProc
        DataProc <--> Viz
    end

    subgraph "Data Layer"
        XLS[("XLS Files")]:::data
        CSV[("CSV Files")]:::data
        XML[("XML Files")]:::data
        DataHandler["Data Handler"]:::data
        
        XLS --> DataHandler
        CSV --> DataHandler
        XML --> DataHandler
        DataHandler --> DataProc
    end

    subgraph "Interface Layer"
        Jupyter["Jupyter Notebooks"]:::interface
        Voila["Voila Apps"]:::interface
        Binder["Binder"]:::interface
        Colab["Google Colab"]:::interface
    end

    subgraph "Documentation Layer"
        MainDocs["Main Documentation"]:::docs
        APIDocs["API Documentation"]:::docs
        Tutorials["Tutorials"]:::docs
    end

    subgraph "Visualization Layer"
        FigureShare["Figure Sharing"]:::viz
        PlotFuncs["Plotting Functions"]:::viz
        ExampleViz["Example Visualizations"]:::viz
        
        Viz --> FigureShare
        Viz --> PlotFuncs
        PlotFuncs --> ExampleViz
    end

    DataProc --> Jupyter
    DataProc --> Voila
    DataProc --> Binder
    DataProc --> Colab

    classDef core fill:#2374ab,stroke:#000,stroke-width:2px
    classDef data fill:#57a773,stroke:#000,stroke-width:2px
    classDef interface fill:#ff8c42,stroke:#000,stroke-width:2px
    classDef docs fill:#845ec2,stroke:#000,stroke-width:2px
    classDef viz fill:#ff5e5b,stroke:#000,stroke-width:2px

    click Models "https://github.com/rheopy/rheofit/blob/master/rheofit/models.py"
    click DataProc "https://github.com/rheopy/rheofit/blob/master/rheofit/rheodata.py"
    click Viz "https://github.com/rheopy/rheofit/blob/master/rheofit/visualization.py"
    click XLS "https://github.com/rheopy/rheofit/blob/master/docs/source/_static/Flow_curve_example.xls"
    click XML "https://github.com/rheopy/rheofit/blob/master/docs/source/_static/Flow_curve_example.xml"
    click Jupyter "https://github.com/rheopy/rheofit/tree/master/notebooks/"
    click Voila "https://github.com/rheopy/rheofit/tree/master/notebooks/example_voila/"
    click MainDocs "https://github.com/rheopy/rheofit/tree/master/docs/"
    click APIDocs "https://github.com/rheopy/rheofit/blob/master/docs/source/rheofit.rst"
    click Tutorials "https://github.com/rheopy/rheofit/blob/master/docs/source/Quickstart.ipynb"
    click FigureShare "https://github.com/rheopy/rheofit/tree/master/data/Altair_figure_sharing/"
    click PlotFuncs "https://github.com/rheopy/rheofit/blob/master/data/Manon/plot_function.py"
    click ExampleViz "https://github.com/rheopy/rheofit/blob/master/data/Altair_figure_sharing/Sharing_figures_and_data_with_altair.ipynb"
```
