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

README: Mermaid flow diagram #26

Open
kaedonkers opened this issue Jul 10, 2023 · 1 comment
Open

README: Mermaid flow diagram #26

kaedonkers opened this issue Jul 10, 2023 · 1 comment

Comments

@kaedonkers
Copy link
Contributor

GitHub now natively supports Mermaid flow diagrams in rendered Markdown files (https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/).

We have a flow diagram in this project, so this issue is to capture code and thinking about including an interactive flow diagram in the repo README.

@kaedonkers
Copy link
Contributor Author

kaedonkers commented Jul 10, 2023

Best example I came up with was this, which isn't very satisfying:

flowchart LR
    A[Data Collection & Processing]
    B[Correlation Threshold]
    C[Random Forest]
    D[Bayesian Network]
    E[Dynamics Visualisations]
    F[Linear Regression]

    subgraph _
        direction LR
        A --> B --> C --> D --> E --> F
    end

    H[Historical Climate Indices]
    I[Global Meteorological Reanalysis]
    J[Regional Temperature Reanalysis]
    K[Chronological & Causal Rules]
    L[Global Meteorological Analysis]
    M[Regional Temperature Forecast]
    
    subgraph __
        direction LR
        H --> A
        I --> A
        J --> B
        J --> C
        K --> D
        L --> E
        F --> M
    end
flowchart LR
    A[Data Collection & Processing]
    B[Correlation Threshold]
    C[Random Forest]
    D[Bayesian Network]
    E[Dynamics Visualisations]
    F[Linear Regression]

    subgraph _
        direction LR
        A --> B --> C --> D --> E --> F
    end

    H[Historical Climate Indices]
    I[Global Meteorological Reanalysis]
    J[Regional Temperature Reanalysis]
    K[Chronological & Causal Rules]
    L[Global Meteorological Analysis]
    M[Regional Temperature Forecast]
    
    subgraph __
        direction LR
        H --> A
        I --> A
        J --> B
        J --> C
        K --> D
        L --> E
        F --> M
    end

Loading

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

No branches or pull requests

1 participant