rail_plot CLI

rail-plot

RAIL plotting functions

These commands to work with RailProject infrastructure to generate sets of standard plots and html pages to help browse them.

The configuration file can include these yaml_tags

Plots with type of plots available
Data with specific datasets we can make those plots with
PlotGroup with combinations of the two

rail-plot [OPTIONS] COMMAND [ARGS]...

Options

--version: Show the version and exit.

Inspecting plotting configuration files

rail-plot run

Inspect a configuration yaml file

These will load the configuration file, and any files that that it includes and then print out the contents of the component library.

rail-plot run [OPTIONS] CONFIG_FILE

Arguments

CONFIG_FILE: Required argument

Extracting datasets from a RailProject

rail-plot extract-datasets

Create a yaml file with the datasets in a project

This will read a yaml project configuration file and search the project for all the datasets that the extractor_class is able to extract and write the results to the output_yaml file.

rail-plot extract-datasets [OPTIONS] CONFIG_FILE

Options

--dataset-holder-class <dataset_holder_class>: Class for the dataset holder

--output-yaml <output_yaml>: Name for output yaml file

--dataset-list-name <dataset_list_name>: Name for dataset list

--flavor <flavor>: Pipeline configuraiton flavor

--selection <selection>: Data selection

--split-mode <split_mode>

How to split datasets within a project

Options:: no_split | by_flavor | by_algo

Arguments

CONFIG_FILE: Required argument

Combining plots with available datasets

Making plots

rail-plot run

Make a bunch of plots

The configuration file should define both the plots to make and the datasets to use.

rail-plot run [OPTIONS] CONFIG_FILE

Options

--include-groups <include_groups>: Plot groups to include

--exclude-groups <exclude_groups>: Plot groups to exclue

--save-plots: Save plots to disk

--purge-plots: Purge plots from memory after saving

--find-only: Find existing plots, do not create new ones

--make-html: Make html files to help browse plots

--outdir <outdir>: Output directory.

Arguments

CONFIG_FILE: Required argument