:mod:`km3pipe.cmd`
==================

.. py:module:: km3pipe.cmd

.. autoapi-nested-parse::

   KM3Pipe command line utility.

   Usage:
       km3pipe test
       km3pipe update [GIT_BRANCH]
       km3pipe createconf [--overwrite] [--dump]
       km3pipe detx DET_ID [-m] [-t T0_SET] [-c CALIBR_ID] [-o OUTFILE]
       km3pipe detectors [-s REGEX] [--temporary]
       km3pipe rundetsn [--temporary] RUN DETECTOR
       km3pipe retrieve DET_ID RUN [-o OUTFILE]
       km3pipe git
       km3pipe git-short
       km3pipe (-h | --help)
       km3pipe --version

   Options:
       -h --help           Show this screen.
       -m                  Get the MC detector file (flips the sign of DET_ID).
       -c CALIBR_ID        Geometrical calibration ID (eg. A01466417)
       -o OUTFILE          Output filename.
       -t T0_SET           Time calibration ID (eg. A01466431)
       -s REGEX            Regular expression to filter the runsetup name/id.
       --temporary         Use a temporary session. [default: False]
       --overwrite         Overwrite existing config [default: False]
       DET_ID              Detector ID (eg. D_ARCA001).
       DETECTOR            Detector (eg. ARCA).
       GIT_BRANCH          Git branch to pull (eg. develop).
       RUN                 Run number.

   ..
       !! processed by numpydoc !!










Module Contents
---------------







Functions
~~~~~~~~~
.. autoapisummary::


   km3pipe.cmd.run_tests
   km3pipe.cmd.update_km3pipe
   km3pipe.cmd.retrieve
   km3pipe.cmd.detx
   km3pipe.cmd.detectors
   km3pipe.cmd.rundetsn
   km3pipe.cmd.createconf
   km3pipe.cmd.print_git_revision
   km3pipe.cmd.print_git_short_revision
   km3pipe.cmd.main






.. data:: log
   

   



















































.. function:: run_tests()

   









.. function:: update_km3pipe(git_branch='')

   









.. function:: retrieve(run_id, det_id, outfile=None)

   
   Retrieve run from iRODS for a given detector (O)ID















   ..
       !! processed by numpydoc !!

   









.. function:: detx(det_id, calibration='', t0set='', filename=None)

   









.. function:: detectors(regex=None, sep='\t', temporary=False)

   
   Print the detectors table















   ..
       !! processed by numpydoc !!

   









.. function:: rundetsn(run_id, detector='ARCA', temporary=False)

   
   Print the detector serial number for a given run of ARCA/ORCA















   ..
       !! processed by numpydoc !!

   









.. function:: createconf(overwrite=False, dump=False)

   









.. function:: print_git_revision()

   
   Prints the last git commit hash















   ..
       !! processed by numpydoc !!

   









.. function:: print_git_short_revision()

   
   Prints the last git commit short hash















   ..
       !! processed by numpydoc !!

   









.. function:: main()