Command-line Tools

You can get a list of all available command-line tools by typing

ctapipe-info --tools

Data Processing Tools

• ctapipe-quickstart: create some default analysis configurations and a working directory

• ctapipe-process: Process event data in any supported format from R0/R1/DL0 to DL1 or DL2 HDF5 files.

• ctapipe-apply-models: Tool to apply machine learning models in bulk (as opposed to event by event).

• ctapipe-calculate-pixel-statistics: Tool to aggregate statistics and detect outliers from pixel-wise image data.

• ctapipe-train-disp-reconstructor : Train the ML models for the DispReconstructor (monoscopic reconstruction)

• ctapipe-train-energy-regressor: Train the ML models for the EnergyRegressor (energy estimation)

• ctapipe-train-particle-classifier: Train the ML models for the ParticleClassifier (gamma-hadron separation)

• ctapipe-optimize-event-selection: Calculate gamma/hadron and direction cuts (e.g. for IRF calculation).

• ctapipe-compute-irf: Calculate an IRF with or without applying a direction cut and optionally benchmarks.

• ctapipe-store-astropy-cache: Store astropy downloadable data in a given directory. Useful to run ctapipe in clusters where worker nodes might not have internet access.

File Management Tools:

• ctapipe-merge: Merge multiple ctapipe HDF5 files into one

• ctapipe-fileinfo: Display information about ctapipe HDF5 output files

Other Tools

• ctapipe-info: print information about your ctapipe installation and its command-line tools.

• ctapipe-dump-instrument: writes instrumental info from any supported event input file, and writes them out as FITS or ECSV files for external use.

Examples

The following pages contain examples on how to use the command-line tools.

• How to do DL2 reconstruction using ctapipe tools
• How to use the cut optimization and the irf tool to create an IRF using ctapipe