arcIsaProcessMermaid 1.1.0

arcIsaProcessMermaid

Tool to generate a minimal markdown containing a mermaid graph that displays an ARC's connections of ISA processes from ARC investigation through studies and assays

💡 This tool is not meant as a long-term solution, but a quickfix and to illustrate what could readily and automatically be read from an ARC using the ARCtrl library.

Installation

The tool ist released via nuget.

1. Install .NET v10.0 or v9.0
2. Run dotnet tool install --global arcIsaProcessMermaid

Usage

Open a command line or terminal and run arcIsaProcessMermaid -p local/path/to/ARC.

USAGE: arcIsaProcessMermaid [--help] [--arcpath <path>] [--outpath <path>] [--outputmmd]

OPTIONS:

    --arcpath, -p <path>  specify path to an ARC
    --outpath, -o <path>  specify a file path and name to write results to (Default: `<path/to/ARC/arc-mermaid>.md or .mmd`)
    --outputmmd, -mmd     whether to output a .mmd file instead of markdown
    --samplenumbers, -sn  whether to add the number of samples between processes to edges
    --flowdirection, -fd  specify the direction of the flowchart: `topDown` (Default) or `leftRight`
    --version, -v         show tool version
    --help                display this list of options.

Rationale

Sure, mermaid graphs are not the tool of choice to display the overall complexity of ARCs. And they are far from anything dynamic or interactive.

However, mermaids in markdown

• are quick and can easily be adapted
• are static and should not break too easily (especially with type-safe F# library Siren)
• can readily be displayed in GitLab (i.e. DataHUB) or VSCode (with extensions)

Recommended mermaid VS Code extensions

To display the resulting mermaid graph, preview the file in VS Code with extensions installed:

• Markdown Preview Mermaid Support
• Mermaid Editor

Alternatively, copy/paste it to Mermaid Live Editor.

Idea

Based on discussions before and during the ARC-Process-GraphViz project at ARC symposium 2024.

Development

Tests

Run

dotnet test

or

dotnet run --framework net10.0 --project ./tests/Tests.fsproj dotnet run --framework net9.0 --project ./tests/Tests.fsproj

Watch

dotnet watch run --framework net9.0 --project ./tests/Tests.fsproj

Using the package in scripts

The core functions can directly be used in .NET, e.g. in an F#-script:

#r "nuget: arcIsaProcessMermaid.Core, 1.0.1-alpha.1"

open ArcIsaProcessMermaid.Core
open ARCtrl

let arcPath = <path/to/ARC>

let arc = ARC.load(arcPath)

ArcSiren.createArcProcessMermaid Siren.Direction.TD arc