Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Workflow diagram in docs #1074

Closed
ns-rse opened this issue Jan 21, 2025 · 2 comments · Fixed by #1078
Closed

Update Workflow diagram in docs #1074

ns-rse opened this issue Jan 21, 2025 · 2 comments · Fixed by #1078
Assignees
Labels

Comments

@ns-rse
Copy link
Collaborator

ns-rse commented Jan 21, 2025

GitDiagram analyses a repository and creates a nice Mermaid diagram.

We should use this in our docs/workflow.md

graph TB
    subgraph Input
        IF[Input Files]
        IO["Input/Output Layer"]:::io
    end

    subgraph Configuration
        CM["Configuration Management"]:::config
        VL["Validation Layer"]:::validation
    end

    subgraph "Core Processing"
        PL["Processing Layer"]:::processing
        FM["Filtering Module"]:::filter
    end

    subgraph "Analysis Layer"
        GA["Grain Analysis"]:::analysis
        SM["Statistics Module"]:::analysis

        subgraph "Tracing System"
            TS["Tracing Subsystem"]:::tracing
            OT["Ordered Tracing"]
            DT["Disordered Tracing"]
            NS["Node Statistics"]
            SP["Splining"]
            DC["DNA Curvature"]
        end
    end

    subgraph "Measurement System"
        GM["Geometry"]:::measure
        CM2["Curvature"]:::measure
        HP["Height Profiles"]:::measure
        FA["Feret Analysis"]:::measure
    end

    subgraph "Visualization"
        PS["Plotting System"]:::viz
        TM["Theme Management"]:::viz
        OUT["Output Generation"]
    end

    IF --> IO
    IO --> PL
    CM --> VL
    VL --> PL
    PL --> FM
    FM --> GA
    FM --> SM
    GA --> TS
    SM --> TS

    TS --> OT
    TS --> DT
    OT --> NS
    DT --> NS
    NS --> SP
    SP --> DC

    GA --> GM
    GA --> CM2
    GA --> HP
    GA --> FA

    GM --> PS
    CM2 --> PS
    HP --> PS
    FA --> PS
    TS --> PS
    PS --> TM
    TM --> OUT

    classDef io fill:#90EE90
    classDef config fill:#A9A9A9
    classDef processing fill:#87CEEB
    classDef filter fill:#87CEEB
    classDef analysis fill:#FFA500
    classDef tracing fill:#FFA500
    classDef measure fill:#DDA0DD
    classDef viz fill:#9370DB
    classDef validation fill:#A9A9A9

    click IO "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/io.py"
    click PL "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/processing.py"
    click FM "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/filters.py"
    click GA "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/grains.py"
    click SM "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/statistics.py"
    click TS "https://github.com/AFM-SPM/TopoStats/tree/main/topostats/tracing/"
    click CM "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/default_config.yaml"
    click VL "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/validation.py"
    click GM "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/measure/geometry.py"
    click CM2 "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/measure/curvature.py"
    click HP "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/measure/height_profiles.py"
    click FA "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/measure/feret.py"
    click PS "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/plotting.py"
    click TM "https://github.com/AFM-SPM/TopoStats/blob/main/topostats/theme.py"
Loading
@RajathKP
Copy link

Hi ,

I would like to work on above issue. Please assigned to me.

Thank You

@ns-rse
Copy link
Collaborator Author

ns-rse commented Jan 23, 2025

Hi @RajathKP

Thanks for taking an interest in TopoStats.

I actually added the above diagram to our docs yesterday in #1078 which is out for review.

@MaxGamill-Sheffield also has work in the pipeline of more detailed steps of processing by many of the modules that we will be reviewing and incorporating.

You are more than welcome to fork the repository and make contributions though (doesn't require assignment) and we will review any pull requests.

Cheers,

@ns-rse

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants