# astro313/uvmcmcfit architecture

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

- Interactive diagram: https://gitdiagram.com/astro313/uvmcmcfit
- Repository: https://github.com/astro313/uvmcmcfit

## Overview

##### Main Components Identification
- Input/Setup Module:
- Components: “config.yaml” (configuration file), target image, and uvfits files.
- Related utility modules: setuputil.py, py2yaml.py.
- The user’s working directory (e.g., “uvfit00”, “uvfit01”) is assumed to be the root for a particular run.
- Model Fitting Engine:
- Core processing happens in uvmcmcfit.py which orchestrates the MCMC fitting.
- Other key modules like uvmodel.py and uvutil.py assist by defining the interferometric model and utilities for data manipulation.
- lensutil.py contains functions for handling lens models (e.g., singular isothermal ellipsoid profiles) and source representations (e.g., Gaussian profiles).
- Data Handling and Utilities:
- miriadutil.py, grid.py, and checkvis.py appear to support reading or pre-processing of uvfits (visibilities) or data grid processing.
- Additional modules such as sample_vis.py, modifypdf.py, and visualutil.py provide specific functionalities such as sample visibility creation, posterior PDF modifications, or visualization assistance.
- Visualization/Output:
- Output generation for MCMC results (“posteriorpdf.fits”) is crucial.
- Documentation:
- The “docs” directory holds comprehensive Sphinx-generated documentation including both developer and user guides.

##### Relationships & Interactions
- User Input (via “config.yaml”, uvfits files, and images) → Setup/Configuration module.
- Setup/Configuration module → initializes and formats the input data, possibly using utilities (setuputil.py, py2yaml.py).
- Processed input data is then fed to the Model Fitting Engine (uvmcmcfit.py), which, in turn, calls various helper modules:
- uvmodel.py: constructs the theoretical model defined by the configuration.
- uvutil.py and miriadutil.py: handle data transformations and computations on the measurements.
- lensutil.py: computes lensing transformations and related modeling.
- The MCMC process iteratively refines parameter estimates and saves them into “posteriorpdf.fits”.

##### Architectural Patterns & Design Principles
- Modular design: The project is divided into distinct modules for configuration, data processing, model fitting, and visualization.
- Separation of concerns: Each Python file appears to address a specific task (e.g., “uvmcmcfit.py” handles the core fitting, “lensutil.py” manages lens-specific computations).
- Command-line oriented: The entire workflow is driven by scripts that expect a pre-formatted directory structure (with config.yaml and corresponding data files) and then perform batch processing.
- Reusability: The presence of multiple utility scripts (e.g., sample_vis.py, checkvis.py) suggests that functionality is encapsulated to be reused across different types of analysis.

## Diagram (Mermaid)

```mermaid
flowchart TD

    %% User Data
    subgraph "User Data"
        UD1["config.yaml (Configuration)"]
        UD2["Target Image"]
        UD3["uvfits Files (Interferometric Data)"]
    end

    %% Input/Setup Module
    subgraph "Input/Setup Module"
        IS1["setuputil.py"]
        IS2["py2yaml.py"]
    end

    %% Core Processing/MCMC Engine
    subgraph "Core Processing/MCMC Engine"
        MP1["uvmcmcfit.py (MCMC Engine)"]
        MP2["uvmodel.py (Interferometric Model)"]
        MP3["uvutil.py (Data Utility)"]
    end

    %% Lens Modeling
    subgraph "Lens Modeling"
        LM1["lensutil.py (Lens Models)"]
    end

    %% Data Handling & Preprocessing Utilities
    subgraph "Data Handling & Preprocessing Utilities"
        UTIL1["checkvis.py (Visibility Checker)"]
        UTIL2["miriadutil.py (Data Transformation)"]
        UTIL3["grid.py (Grid Processing)"]
        UTIL4["sample_vis.py (Sample Visibilities)"]
        UTIL5["modifypdf.py (PDF Modifier)"]
    end

    %% Visualization & Post-processing
    subgraph "Visualization & Post-processing"
        VIS1["visualize.py (Plotting)"]
        VIS2["visualutil.py (Visualization Utility)"]
    end

    %% Output Storage
    subgraph "Output Storage"
        OUT1["posteriorpdf.fits (MCMC Results)"]
        OUT2["log.txt (Logs)"]
    end

    %% Documentation
    subgraph "Documentation"
        DOC1["docs (Documentation)"]
    end

    %% Data Flow Connections

    %% User Data to Input/Setup
    UD1 -->|"input"| IS1
    UD2 -->|"input"| IS1
    UD3 -->|"input"| IS1

    %% Input/Setup to Core Processing
    IS1 -->|"processes configuration"| MP1
    IS2 -->|"parses YAML"| MP1

    %% Core Processing internal calls
    MP1 -->|"builds model"| MP2
    MP1 -->|"data utilities"| MP3
    MP1 -->|"applies lens modeling"| LM1

    %% Core Processing uses Data Handling Utilities
    MP1 -->|"checks visibilities"| UTIL1
    MP1 -->|"transforms data"| UTIL2
    MP1 -->|"processes grid"| UTIL3
    MP1 -->|"samples visibilities"| UTIL4
    MP1 -->|"modifies PDF"| UTIL5

    %% Core Processing outputs and logging
    MP1 -->|"saves results"| OUT1
    MP1 -->|"logs activity"| OUT2

    %% Core Processing to Visualization
    MP1 -->|"generates plots"| VIS1
    MP1 -->|"visual support"| VIS2

    %% Link Documentation to Core Processing
    MP1 -->|"documented in"| DOC1

    %% Styling
    class UD1,UD2,UD3 userData
    class IS1,IS2 inputModule
    class MP1,MP2,MP3 coreEngine
    class LM1 lensModel
    class UTIL1,UTIL2,UTIL3,UTIL4,UTIL5 dataUtil
    class VIS1,VIS2 visOutput
    class OUT1,OUT2 outputStorage
    class DOC1 documentation

    %% Class Definitions
    classDef userData fill:#B3CDE0,stroke:#000,stroke-width:1px;
    classDef inputModule fill:#CCEBC5,stroke:#000,stroke-width:1px;
    classDef coreEngine fill:#DECBE4,stroke:#000,stroke-width:1px;
    classDef lensModel fill:#FED9A6,stroke:#000,stroke-width:1px;
    classDef dataUtil fill:#FFFFCC,stroke:#000,stroke-width:1px;
    classDef visOutput fill:#FDDAEC,stroke:#000,stroke-width:1px;
    classDef outputStorage fill:#D9D9D9,stroke:#000,stroke-width:1px;
    classDef documentation fill:#D0E1F9,stroke:#000,stroke-width:1px;

    %% Click Events
    click IS1 "https://github.com/astro313/uvmcmcfit/blob/master/setuputil.py"
    click IS2 "https://github.com/astro313/uvmcmcfit/blob/master/py2yaml.py"
    click MP1 "https://github.com/astro313/uvmcmcfit/blob/master/uvmcmcfit.py"
    click MP2 "https://github.com/astro313/uvmcmcfit/blob/master/uvmodel.py"
    click MP3 "https://github.com/astro313/uvmcmcfit/blob/master/uvutil.py"
    click LM1 "https://github.com/astro313/uvmcmcfit/blob/master/lensutil.py"
    click UTIL1 "https://github.com/astro313/uvmcmcfit/blob/master/checkvis.py"
    click UTIL2 "https://github.com/astro313/uvmcmcfit/blob/master/miriadutil.py"
    click UTIL3 "https://github.com/astro313/uvmcmcfit/blob/master/grid.py"
    click UTIL4 "https://github.com/astro313/uvmcmcfit/blob/master/sample_vis.py"
    click UTIL5 "https://github.com/astro313/uvmcmcfit/blob/master/modifypdf.py"
    click VIS1 "https://github.com/astro313/uvmcmcfit/blob/master/visualize.py"
    click VIS2 "https://github.com/astro313/uvmcmcfit/blob/master/visualutil.py"
    click DOC1 "https://github.com/astro313/uvmcmcfit/tree/master/docs/"
```
