use ctapipe.core.provenance to track open files

[kosack]

I notice that there are multiple files opened at various times in this code. Any time you open a file, you must register it with ctapipe's provenance system, so that we can track what depends on what (a requirement of CTA).

So if you don't use ctapipe.utils.get_dataset_* (which do it automatically), you must do it manually as follows:

from ctapipe.core import Provenance


...
# for inputs:
Provenance().add_input_file("LSTCam.camgeom.fits", role="CameraGeometry") 

# for outputs:
Provenance().add_output_file("events.h5", role="DL1/Event") 

Where role shuold be something that describes why you opened the file (e.g. "DL0/Event" or "CameraGeometry", etc.)

Then it will end up automatically in the Tool output (in provenance.log and in stdout if you set the --log-level=DEBUG

The recorded provenance from ctapipe-camdemo --camera MAGICCamMARS --log-level=DEBUG looks like this:

...
      "input": [
         {
            "url": "/Users/kkosack/Library/Caches/Python-Eggs/ctapipe_extra-0.2.18-py3.7.egg-tmp/ctapipe_resources/MAGICCamMars.camgeom.fits.gz",
            "role": "dl0.tel.svc.camera"
         },
         {
            "url": "/Users/kkosack/Library/Caches/Python-Eggs/ctapipe_extra-0.2.18-py3.7.egg-tmp/ctapipe_resources/optics.ecsv.txt",
            "role": "dl0.tel.svc.optics"
         }
      ],
      "output": [],
...