From cd83c31108c59452f508bd57067ca0d26ffa0701 Mon Sep 17 00:00:00 2001 From: Lukas Beiske Date: Mon, 27 Jan 2025 15:17:35 +0100 Subject: [PATCH] Address comments; add changelog --- docs/changes/2691.maintenance.rst | 4 ++++ docs/user-guide/data_models/index.rst | 6 ++---- 2 files changed, 6 insertions(+), 4 deletions(-) create mode 100644 docs/changes/2691.maintenance.rst diff --git a/docs/changes/2691.maintenance.rst b/docs/changes/2691.maintenance.rst new file mode 100644 index 00000000000..90ba1d3f46c --- /dev/null +++ b/docs/changes/2691.maintenance.rst @@ -0,0 +1,4 @@ +Add a tutorial to the docs on how to use the machine learning tools +to process dl1b (image parameters) files to dl2 for a mono analysis. + +Perform minor updates to other parts of the api docs and the user-guide. diff --git a/docs/user-guide/data_models/index.rst b/docs/user-guide/data_models/index.rst index 9da5e0f1710..8e8fb40eabb 100644 --- a/docs/user-guide/data_models/index.rst +++ b/docs/user-guide/data_models/index.rst @@ -4,10 +4,8 @@ Data Models *********** -The DL1 files are HDF5 format files, with the following data set hierarchy. -The tables should be written with `pytables `_ (not ``h5py``), -ideally with the :py:class:`~ctapipe.io.HDF5TableWriter`, which ensures the unit -and other descriptive metadata are attached to the output. +The ``ctapipe`` output files are HDF5 format files, with the following data set hierarchy. +The tables are written with `pytables `_ (not ``h5py``). Containers marked with a ``+`` should be written without their prefix (all others should use column prefixes). The following describes the contents of data level 1 (DL1) output files