Start working on main ctapipe cli tool

[maxnoe]

Fixes #850

I will also update the tools documentation in this PR, leaving as draft for now

[kosack]

I remember trying this in the past and there was something in our Tool base class that broke sub-commands. I guess whatever it was is fixed! Nice

[maxnoe]

At least I didn't find anything immediately wrong:

ctapipe process -i dataset://gamma_prod5.simtel.zst -o /tmp/foo.dl1.h5 --progress

for example works correctly here.

❯ ctapipe --help
Main entry point for ctapipe, provides other tools as subcommands

Subcommands
===========
Subcommands are launched as `ctapipe cmd [args]`. For information on using
subcommand 'cmd', do: `ctapipe cmd -h`.

process
    ctapipe event-wise data processing
apply-models
    Apply trained machine learning models
train-energy-regressor
    Train telescope-type-wise energy regression models
train-particle-classifier
    Train telescope-type-wise binary classficiation models
train-disp-regressor
    Train telescope-type-wise disp regression models for direction reconstruction
info
    Print information about ctapipe and the current installation
quickstart
    Create a directory with example configuration files

[kosack]

missing "fileinfo" tool

[kosack]

I just pushed a few commits to convert ctapipe-fileinfo into a Tool and include it in this list. So this should be fixed now.

[kosack]

If you want to go full-hierarchy, you could also add a second layer for train:

% ctapipe train --help

Subcommands
===========
Subcommands are launched as `ctapipe train cmd [args]`. For information on using
subcommand 'cmd', do: `ctapipe train cmd -h`.

energy-regressor:
     Train energy regression model
particle-classifier:
    Train telescope-type-wise binary classficiation models
disp-regressor:
    Train telescope-type-wise disp regression models for direction reconstruction

% ctapipe train energy-regressor --help

Especially since we may add reco-uncertainty-regressor, event-type-classifier, and maybe others

[kosack]

A few things still missing here:

• we lose tab completion. Not a huge problem, but this could be solved by adding a bash/fish completion script. There is still of course tab completion of the underlying tools (e.g. ctapipe-process)

• the docstring for each tool is now in three places. Is there a way we can simplify this?

  • the top of each file (used in ctapipe-info --tools)
  • the docstring of each Tool class (used in the notebook repr and python help)
  • the hard-coded string in __main__.py

[kosack]

One more issue to solve: commands that use positional arguments don't seem to work in sub-commands. For example:

Works:

ctapipe-fileinfo f1.h5 f2.h5

Fails:

ctapipe fileinfo f1.h5 f2.h5
# the main program fails, as it tries to interpret the last two files as commands.

It still works using

ctapipe fileinfo --input-file f1.h5 --input-file f2.h5

but that defeats the purpose and makes it hard to do thing like ctapipe fileinfo *.h5.

This may also affect the merge tool, which also accepts positional args