Welcome to VdM Tools’s documentation!

The VdM Tools package is a centralised repository of auxiliary tools for the analysis of the VdM Framework output.

Installation 

With git 

The vdmtools package can be installed directly from the gitlab repository. To do so, run:

pip install "vdmtools @ git+https://gitlab.cern.ch/flpereir/vdmtools.git"

Note

To install with developer dependencies, run pip install "vdmtools[dev] @ git+https://gitlab.cern.ch/flpereir/vdmtools.git"

From source 

The vdmtools package can be installed in CERN machines as well as in your own machine. Independent of where you are installing the package, first clone the repository:

git clone https://gitlab.cern.ch/flpereir/vdmtools.git

After cloning the repository, go to the root directory of the package:

cd vdmtools

CERN machines

Instalation in CERN machine is to be done by the following steps:

Source the env.sh file in the root directory of the package. This will set up the environment for both lxplus7 and lxplus9 machines.
```
source env.sh
```
Note

This step may suffer changes in the future due to current migration in CERN machines.
Install the package by running using pip:
```
pip install .
```
Note

To install with developer dependencies, run pip install .[dev]

Your own machine

To install the package in your own machine, it is best pratice to create a virtual environment and install the package there. Assuming you are already in a virtual environment (see this for help), you can install the package by running:

pip install .[local]

Note

Developer dependencies can be installed like before.

Commands 

The vdmtools package provides a number of command line tools which can be used to perform various tasks. These tools are prefixed with vdm.

Plugin Tool - `vdmplugin`

The vdmplugin tool is used for everyting plugins related. This tool is composed of subtools that help with the management of plugins in their own right.

$ vdmplugin --help

The output will be:

usage: vdmplugin [-h] [--log-level] SUBCOMMANDS ...

VDM plugin management

positional arguments:
  SUBCOMMANDS
    summary     Summarize all existing plugins
    clone       Clone an internal plugin to an external directory

optional arguments:
  -h, --help    show this help message and exit
  --log-level   Set the log level. Choose from DEBUG, INFO, WARNING, ERROR,
                CRITICAL

Plotting Tool - `vdmplot`

The vdmplot provides the entry point for using the plot plugins. It’s from this tool that the user take advantage of the plotting plugins that are available.

$ vdmplot --help

The output will be:

usage: vdmplot [-h] [--log-level] SUBCOMMANDS ...

Plotting engine for VDMTools

positional arguments:
  SUBCOMMANDS
    run-config       Run the plotting engine with a config file
    describe-strategy
                     Describe the plot strategies available in a plugin
    open-pickle      Open a previously pickled plot
    create-plugin    Create a new plugin

optional arguments:
  -h, --help         show this help message and exit
  --log-level        Set the log level. Choose from DEBUG, INFO, WARNING,
                     ERROR, CRITICAL

Scripts Tool - `vdmscript`

The vdmscripts tool is used to run scripts that are available in the package. These scripts are used to perform general tasks.

$ vdmscripts --help

The output will be:

usage: vdmscripts [-h] [--log-level] SUBCOMMANDS ...

Scripts for VdMTools.

positional arguments:
  SUBCOMMANDS
    h2b         Convert hd5 data to brilcalc csv format.
    particle    Find out the favorite particle of a particle physicist.

optional arguments:
  -h, --help    show this help message and exit
  --log-level   Set the log level. Choose from DEBUG, INFO, WARNING, ERROR,
                CRITICAL

Communication 

Any issues, bugs, or feature requests can be raised as issues in the here.

Contribution 

The vdmtools package is under active development. If you want to contribute to the package, feel free to open a merge request in the gitlab repository.