:py: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 retrieve DET_ID RUN [-i -o OUTFILE]
       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)
       -i                  Use iRODS instead of xrootd to retrieve files.
       -o OUT              Output folder or filename.
       -t T0_SET           Time calibration ID (eg. A01466431)
       -s REGEX            Regular expression to filter the runsetup name/id.
       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.main



Attributes
~~~~~~~~~~

.. autoapisummary::

   km3pipe.cmd.log
   km3pipe.cmd.SPS_CACHE
   km3pipe.cmd.KM3PIPE_GIT


.. py:data:: log

   

.. py:data:: SPS_CACHE
   :value: '/sps/km3net/repo/data/cache'

   

.. py:data:: KM3PIPE_GIT
   :value: 'https://git.km3net.de/km3py/km3pipe.git'

   

.. py:function:: run_tests()


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


.. py:function:: retrieve(run_id, det_id, use_irods=False, out=None)

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
















   ..
       !! processed by numpydoc !!

.. py:function:: main()