ARTIST

Advanced Representation of MRF TIming System Topology

This script takes a file in input with the EPICS Prefix used to control every EVMs and EVRs of your system. It results a mermaid graph representing your timing topology and to which port each EVRs is connected to EVMs.

flowchart
  2 <-->|Port 1| 21[mTCA-EVR-300\nEVR2]
  2 <-->|Port 2| 22[mTCA-EVR-300\nEVR4]
  0[EVM Master] <-->|Port 1| 1[mTCA-EVR-300\n EVR1]
  0[EVM Master] <-->|Port 3| 3[PCIe-EVR-300DC\n EVR3 PCI] 
  0[EVM Master] <-->|Port 2| 2[EVM Fanout]

Loading

Installation

using Poetry

First, install Poetry. Refer to the Poetry for instructions.

To build the project, you can run:

poetry install
poetry run build

It is using PyInstaller to create a binary in dist

Execution

Using Poetry

To run the script from anywhere in the directory execute

poetry shell

Then you can call the script from anywhere

artist fileListingPrefixes /tmp/outputPath -f wireviz --add-io

Using Binary

If you have build the binary you can

> cd dist
> artist -h

Usage

usage: artist [-h] [-v {0,1,2,3,4,5}] [-f {md,wireviz,graphviz}] [--add-io] inputFile outputPath

Script to draw timing topology to defined format

positional arguments:
 inputFile             File containing the PVList
 outputPath            Result directory

options:
 -h, --help            show this help message and exit
 -v {0,1,2,3,4,5}, --verbosity {0,1,2,3,4,5}
                       decrease output verbosity. 5 (Critical), 4 (Error), 3 (Warning, default), 2 (Info), 1 (Debug)
 -f {md,wireviz,graphviz}, --format {md,wireviz,graphviz}
                       Define which format for the output.
 --add-io              Add input/output of the EVR on the synoptics

Format

For the following list of Prefix in the file listPrefixDevices

- evms:
    - MyPV-EVMMaster::
        - titre: EVMMASTER
        - description: Master EVM 
    - MyPV-EVMFanout1::
        - titre: EVMFANOUT1
        - description: EVM Fanout 1
- evrs:
    - MyPV-EVR1::
        - titre: EVR1
        - description: EVR 1
    - MyPV-EVR2::
        - titre: EVR2
        - description: EVR 2
    - MyPV-EVR3::
        - titre: EVR3
        - description: EVR 3

Mermaid

Execution of the script with the format mermaid will give you that

> artist listPrefixDevices
graph TD;
  0[EVM Master] <-->|Port 2| 2[mTCA-EVR-300
EVR BDM]
  0[EVM Master] <-->|Port 5| 5[mTCA-EVR-300
EVR SBCT]

you can use https://mermaid.live to draw the mermaid result as a graph.

Graphviz

You can also generate graphviz format https://graphviz.org/

Wireviz

You can also generate wireviz format synoptic https://github.com/wireviz/WireViz

⚠️ : Graphviz need to be installed in your computer, if you use the binary. No problem with poetry.