Add tutorial for mono dl1b to dl2 and update docs #2691
Conversation
LukasBeiske
changed the title
This comment has been minimized.
This comment has been minimized.
|
I think adding an entire tutorial is worth mentioning in the changelog. |
This comment has been minimized.
This comment has been minimized.
LukasBeiske
force-pushed
the
add_mono_dl2_guide
branch
from
0622d19 to
4bcf878
Compare
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Looks good! I wonder if the tutorial should be under tutorials instead of tools, but I think that can wait for a future PR, as there is a lot of documentation cleanup and reorganization that also needs to be done (like actually separating examples and tutorials in the index..).
Also, it looks like you might need to rebase on main since there are branch conflicts.
The tutorials section is our section for notebooks generated by sphinx-gallery, not sure if it's possible to add a static rst page there |
LukasBeiske
force-pushed
the
add_mono_dl2_guide
branch
from
4bcf878 to
cd83c31
Compare
This comment has been minimized.
This comment has been minimized.
| @@ -4,6 +4,127 @@ | |||
| Data Models | |||
| *********** | |||
|
|
|||
| .. toctree:: | |||
| The ``ctapipe`` output files are HDF5 format files, with the following data set hierarchy. | |||
There was a problem hiding this comment.
Better if you say the data hierarchy is described "below" as that implies some distance, while "following" means something more like "directly after here".
There was a problem hiding this comment.
All of this is the old content of user-guide/data_models/dl1.rst. I did not write any of this, I just fixed the file structure.
I'll have a look again, if I have time.
But this would probably make more sense in a separate PR with a general overhaul of the docs.
| .. toctree:: | ||
| The ``ctapipe`` output files are HDF5 format files, with the following data set hierarchy. | ||
| The tables are written with `pytables <https://www.pytables.org>`_ (not ``h5py``). | ||
| Containers marked with a ``+`` should be written without their prefix (all others should use column prefixes). |
There was a problem hiding this comment.
Not clear to me what the purpose of these lines is in the user guide? Could you clarify what you want the user to understand?
| - Contents | ||
| * - ``subarray`` | ||
| - event-wise data pertaining to a subarray | ||
| - (group) |
There was a problem hiding this comment.
You should probably explain what "(group)" is supposed to mean, you use with HDF5 terminology without explaining it as far as I can see.
| * - Group/Dataset | ||
| - Description | ||
| - Contents | ||
| * - /geometry |
There was a problem hiding this comment.
Here you give the group with a initial "/" but otherwise not typeset in any special way, where before there was no initial slash but the key was set as code. Later you set the groups as code and include an initial "/".
Decide on how you want to present the subgroups and implement it uniformly. I suggest the first style, set as code and without the slash.
| - :py:class:`~ctapipe.containers.EventIndexContainer`, :py:class:`~ctapipe.containers.ParticleClassificationContainer` | ||
|
|
||
|
|
||
| Simulation Data Model |
There was a problem hiding this comment.
Why is this not presented as a table when all the other data models are?
|
|
||
| * `ctapipe-quickstart <ctapipe.tools.quickstart.QuickStartTool>`: create some default analysis configurations and a working directory | ||
| * `ctapipe-process <ctapipe.tools.process.ProcessorTool>`: Process event data in any supported format from R0/R1/DL0 to DL1 or DL2 HDF5 files. | ||
| * `ctapipe-apply-models <ctapipe.tools.apply_models.ApplyModels>`: Tool to apply machine learning models in bulk (as opposed to event by event). |
There was a problem hiding this comment.
I think the more relevant distinction is that this tool applies the models for you, otherwise you would have to make your own script to do it, right? (And in that script you could apply the models however you wish)
There was a problem hiding this comment.
This should clarify the difference to applying the models using ctapipe-process, so going event-by-event.
This comment has been minimized.
This comment has been minimized.
Analysis Details0 Issues
Coverage and Duplications
Project ID: cta-observatory_ctapipe_AY52EYhuvuGcMFidNyUs |
Since there are only very minor changes in the code itself, do we need a changelog here?