rail_project CLI

rail-project

RAIL project management scripts

These all expect a yaml_configuration file defining the RailProject.

That file can, in turn, include other yaml configuration files that define a ‘library’ of possible analysis components

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

Options

--version

Show the version and exit.

Inspecting configuration files

rail-project inspect

Inspect a rail pipeline project config

rail-project inspect [OPTIONS] CONFIG_FILE

Arguments

CONFIG_FILE

Required argument

Reducing input catalogs

rail-project reduce

Reduce the roman rubin simulations for analysis

This will: resolve a catalog of input files from the catalog_template, and input_selection parameters, resolve a catalog of output files from the output_catalog_template and selection parameters, reduce the input catalog to the output catalog

rail-project reduce [OPTIONS] CONFIG_FILE

Options

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

--catalog-template <catalog_template>

Name of the catalog template to use

--output-catalog-template <output_catalog_template>

Name of the catalog template to use for output

--reducer-class-name <reducer_class_name>

Class for the reducer

--input-selection <input_selection>

Data selection

--selection <selection>

Data selection

Arguments

CONFIG_FILE

Required argument

Subsampling data from catalogs

rail-project subsample

Make a training or test data set by randomly selecting objects from a catalog of input files

This will: resolve a catalog of input files from the catalog_template, flavor, selection and basename parameters, resolve a single output file from the file_template, flavor and selection parameters, subsample from the catalog files and write to the output file.

rail-project subsample [OPTIONS] CONFIG_FILE

Options

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

--catalog-template <catalog_template>

Name of the catalog template to use

--file-template <file_template>

Name of the file template to use

--subsampler-class-name <subsampler_class_name>

Class for the subsampler

--subsample-name <subsample_name>

Name for the subsample

--selection <selection>

Data selection

--flavor <flavor>

Pipeline configuraiton flavor

--basename <basename>

Basename for catalog template resolution

Arguments

CONFIG_FILE

Required argument

Building pipeline configuration files

rail-project build

Build the ceci pipeline configuration files

This will build all of the pipelines associated to a particular flavor or flavors, and write them to the the project pipelines area.

rail-project build [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--force

Overwrite existing ceci configuration files

Arguments

CONFIG_FILE

Required argument

Running pipelines

rail-project run

Run a pipeline

rail-project run [OPTIONS] COMMAND [ARGS]...

blending

Run the blending analysis pipeline

rail-project run blending [OPTIONS] CONFIG_FILE

Options

--selection <selection>

Data selection

--flavor <flavor>

Pipeline configuraiton flavor

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

estimate

Run the estimation pipeline

rail-project run estimate [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

--input-tag <input_tag>

Input Catalog tag

Arguments

CONFIG_FILE

Required argument

estimate-recalib

Run the recalibration estimate pipeline

rail-project run estimate-recalib [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

estimate-sompz

Run the sompz estimate pipeline

rail-project run estimate-sompz [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

evaluate

Run the evaluation pipeline

rail-project run evaluate [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

inform

Run the inform pipeline

rail-project run inform [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

inform-recalib

Run the recalibration inform pipeline

rail-project run inform-recalib [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

inform-somlike

Run the somlike inform pipeline

rail-project run inform-somlike [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

inform-sompz

Run the sompz inform pipeline

rail-project run inform-sompz [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

phot-errors

Run the photometric errors analysis pipeline

rail-project run phot-errors [OPTIONS] CONFIG_FILE

Options

--selection <selection>

Data selection

--flavor <flavor>

Pipeline configuraiton flavor

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

prepare

Run the truth-to-observed data pipeline

rail-project run prepare [OPTIONS] CONFIG_FILE

Options

--selection <selection>

Data selection

--flavor <flavor>

Pipeline configuraiton flavor

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

pz

Run the pz pipeline

rail-project run pz [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

somlike-recalib

Run the somlike recalibration pipeline

rail-project run somlike-recalib [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

spec-selection

Run the spectroscopic selection data pipeline

rail-project run spec-selection [OPTIONS] CONFIG_FILE

Options

--selection <selection>

Data selection

--flavor <flavor>

Pipeline configuraiton flavor

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

tomography

Run the tomography pipeline

rail-project run tomography [OPTIONS] CONFIG_FILE

Options

--flavor <flavor>

Pipeline configuraiton flavor

--selection <selection>

Data selection

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument

truth-to-observed

Run the truth-to-observed data pipeline

rail-project run truth-to-observed [OPTIONS] CONFIG_FILE

Options

--selection <selection>

Data selection

--flavor <flavor>

Pipeline configuraiton flavor

--run-mode <run_mode>

Mode to run script

Options:

dry_run | bash | slurm

Arguments

CONFIG_FILE

Required argument