From 98a522db0ebde5f629555dbf8e24292afed49dfd Mon Sep 17 00:00:00 2001 From: Maximilian Linhoff Date: Mon, 11 Sep 2023 12:47:49 +0200 Subject: [PATCH] Add changelog for 0.20.0 --- CHANGES.rst | 60 +++++++++++++++++++++++++++++++ docs/changes/2265.bugfix.rst | 2 -- docs/changes/2328.feature.rst | 1 - docs/changes/2338.feature.rst | 1 - docs/changes/2342.maintenance.rst | 1 - docs/changes/2343.feature.rst | 5 --- docs/changes/2373.maintenance.rst | 3 -- docs/changes/2375.api.rst | 5 --- docs/changes/2376.api.rst | 2 -- docs/changes/2381.feature.rst | 1 - docs/changes/2384.api.rst | 2 -- docs/changes/2386.feature.rst | 1 - 12 files changed, 60 insertions(+), 24 deletions(-) delete mode 100644 docs/changes/2265.bugfix.rst delete mode 100644 docs/changes/2328.feature.rst delete mode 100644 docs/changes/2338.feature.rst delete mode 100644 docs/changes/2342.maintenance.rst delete mode 100644 docs/changes/2343.feature.rst delete mode 100644 docs/changes/2373.maintenance.rst delete mode 100644 docs/changes/2375.api.rst delete mode 100644 docs/changes/2376.api.rst delete mode 100644 docs/changes/2381.feature.rst delete mode 100644 docs/changes/2384.api.rst delete mode 100644 docs/changes/2386.feature.rst diff --git a/CHANGES.rst b/CHANGES.rst index 19877342a07..eab102af3b5 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,3 +1,63 @@ +ctapipe v0.20.0 (2023-09-11) +============================ + + +API Changes +----------- + +- The ``ctapipe-dump-triggers`` tool was removed, since it wrote a custom data format + not compatble with e.g. the output of the ``DataWriter`` and ``ctapipe-process``. + If you only want to store trigger and simulation information from simulated / DL0 + input files into the ctapipe format HDF5 files, you can now use + ``ctapipe-process -i -o --no-write-parameters``. [`#2375 `__] + +- Change the fill value for invalid telescope ids in ``SubarrayDescription.tel_index_array`` + from ``-1`` to ``np.iinfo(int).minval`` to prevent ``-1`` being used as an index resulting in the last element being used for invalid telescope ids. [`#2376 `__] + +- Remove ``EventSource.from_config``, simply use ``EventSource(config=config)`` or + ``EventSource(parent=parent)``. [`#2384 `__] + + +Data Model Changes +------------------ + +- Added missing fields defined in the CTAO R1 and DL0 data models to the corresponding containers. [`#2338 `__] + +- Remove the ``injection_height`` field from the ``SimulationConfigContainer``, + this field was always empty and is never filled by ``sim_telarray``. + + Add the corresponding ``starting_grammage`` field to the ``SimulatedShowerContainer``, + where it is actually available. [`#2343 `__] + +- Added new fields to the ``MuonEfficiencyContainer`` - ``is_valid`` to check if fit converged successfully, ``parameters_at_limit`` to check if parameters were fitted close to a bound and ``likelihood_value`` which represents cost function value atthe minimum. These fields were added to the output of the ``MuonIntensityFitter``. [`#2381 `__] + + +New Features +------------ + +- Remove writing the full provenance information to the log and instead simply refer the reader to the actual provenance file. [`#2328 `__] + +- Add support for including r1 and r0 waveforms in the ``ctapipe-merge`` tool. [`#2386 `__] + + +Bug Fixes +--------- + +- The ```HillasIntersection``` method used to fail when individual events were reconstructed to originate from a FoV offset of more than 90 degrees. + This is now fixed by returning an INVALID container for a reconstructed offset of larger than 45 degrees. [`#2265 `__] + + +Maintenance +----------- + +- Drop support for python 3.8 in accordance with the NEP 29 schedule. [`#2342 `__] + +- * Switched to ``PyData`` theme for docs + * Updated ``Sphinx`` to version 6.2.1 + * Updated front page of docs [`#2373 `__] + + + ctapipe 0.19.3 (2023-06-20) =========================== diff --git a/docs/changes/2265.bugfix.rst b/docs/changes/2265.bugfix.rst deleted file mode 100644 index 7e637ed4f3e..00000000000 --- a/docs/changes/2265.bugfix.rst +++ /dev/null @@ -1,2 +0,0 @@ -The ```HillasIntersection``` method used to fail when individual events were reconstructed to originate from a FoV offset of more than 90 degrees. -This is now fixed by returning an INVALID container for a reconstructed offset of larger than 45 degrees. \ No newline at end of file diff --git a/docs/changes/2328.feature.rst b/docs/changes/2328.feature.rst deleted file mode 100644 index 6f3de847f94..00000000000 --- a/docs/changes/2328.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Remove writing the full provenance information to the log and instead simply refer the reader to the actual provenance file. diff --git a/docs/changes/2338.feature.rst b/docs/changes/2338.feature.rst deleted file mode 100644 index 0d5faf7a5ea..00000000000 --- a/docs/changes/2338.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added missing fields defined in the CTAO R1 and DL0 data models to the corresponding containers. diff --git a/docs/changes/2342.maintenance.rst b/docs/changes/2342.maintenance.rst deleted file mode 100644 index df37bb4ebba..00000000000 --- a/docs/changes/2342.maintenance.rst +++ /dev/null @@ -1 +0,0 @@ -Drop support for python 3.8 in accordance with the NEP 29 schedule. diff --git a/docs/changes/2343.feature.rst b/docs/changes/2343.feature.rst deleted file mode 100644 index 6367e808206..00000000000 --- a/docs/changes/2343.feature.rst +++ /dev/null @@ -1,5 +0,0 @@ -Remove the ``injection_height`` field from the ``SimulationConfigContainer``, -this field was always empty and is never filled by ``sim_telarray``. - -Add the corresponding ``starting_grammage`` field to the ``SimulatedShowerContainer``, -where it is actually available. diff --git a/docs/changes/2373.maintenance.rst b/docs/changes/2373.maintenance.rst deleted file mode 100644 index 8e5a70349d3..00000000000 --- a/docs/changes/2373.maintenance.rst +++ /dev/null @@ -1,3 +0,0 @@ -* Switched to ``PyData`` theme for docs -* Updated ``Sphinx`` to version 6.2.1 -* Updated front page of docs diff --git a/docs/changes/2375.api.rst b/docs/changes/2375.api.rst deleted file mode 100644 index 36ab27b3d7e..00000000000 --- a/docs/changes/2375.api.rst +++ /dev/null @@ -1,5 +0,0 @@ -The ``ctapipe-dump-triggers`` tool was removed, since it wrote a custom data format -not compatble with e.g. the output of the ``DataWriter`` and ``ctapipe-process``. -If you only want to store trigger and simulation information from simulated / DL0 -input files into the ctapipe format HDF5 files, you can now use -``ctapipe-process -i -o --no-write-parameters``. diff --git a/docs/changes/2376.api.rst b/docs/changes/2376.api.rst deleted file mode 100644 index 62bab6f6cc3..00000000000 --- a/docs/changes/2376.api.rst +++ /dev/null @@ -1,2 +0,0 @@ -Change the fill value for invalid telescope ids in ``SubarrayDescription.tel_index_array`` -from ``-1`` to ``np.iinfo(int).minval`` to prevent ``-1`` being used as an index resulting in the last element being used for invalid telescope ids. diff --git a/docs/changes/2381.feature.rst b/docs/changes/2381.feature.rst deleted file mode 100644 index 4d9e9177c9d..00000000000 --- a/docs/changes/2381.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added new fields to the ``MuonEfficiencyContainer`` - ``is_valid`` to check if fit converged successfully, ``parameters_at_limit`` to check if parameters were fitted close to a bound and ``likelihood_value`` which represents cost function value atthe minimum. These fields were added to the output of the ``MuonIntensityFitter``. diff --git a/docs/changes/2384.api.rst b/docs/changes/2384.api.rst deleted file mode 100644 index 32647abe5eb..00000000000 --- a/docs/changes/2384.api.rst +++ /dev/null @@ -1,2 +0,0 @@ -Remove ``EventSource.from_config``, simply use ``EventSource(config=config)`` or -``EventSource(parent=parent)``. diff --git a/docs/changes/2386.feature.rst b/docs/changes/2386.feature.rst deleted file mode 100644 index eaf9d2f5748..00000000000 --- a/docs/changes/2386.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Add support for including r1 and r0 waveforms in the ``ctapipe-merge`` tool.