Merge pull request #242 from cta-observatory/release_v0.4.2

Release v0.4.2

README.rst

@@ -11,30 +11,27 @@ Repository for the analysis of MAGIC and MAGIC+LST1 data, based on `ctapipe <htt
 * Code: https://github.com/cta-observatory/magic-cta-pipe
 * Docs (preliminary): https://magic-cta-pipe.readthedocs.io/
 
-v0.4.1 of *magic-cta-pipe* provides all the functionalities to perform a MAGIC+LST-1 or a MAGIC-only analysis. Both types of analyses can be performed using the scripts within the *lst1_magic* folder.
+v0.4.2 of *magic-cta-pipe* provides all the functionalities to perform a MAGIC+LST-1 or a MAGIC-only analysis. Both types of analyses can be performed using the scripts within the *lst1_magic* folder.
 See `here <https://magic-cta-pipe.readthedocs.io/en/latest/user-guide/magic-lst-scripts.html>`_ for more details on how to run the analysis.
 
-v0.4.1 is based on *ctapipe* v0.19.x and *cta-lstchain* v0.10.x.
+v0.4.2 is based on *ctapipe* v0.19.x and *cta-lstchain* v0.10.x.
 
 **NOTE ON OLD RELEASES**
 
 v0.3.1 of *magic-cta-pipe* was the last release before the cleanup of old files. Also, it was the last one supporting ctapipe v0.12.
-In order to exploit fully the new functionalities provided by *ctapipe*, use always the latest stable release of *magic-cta-pipe* (currently v0.4.1).
-v0.4.1 contains backward incompatible changes with respect to v0.3.1. Therefore, you cannot mix analyses performed with the two releases.
+In order to exploit fully the new functionalities provided by *ctapipe*, use always the latest stable release of *magic-cta-pipe* (currently v0.4.2).
+v0.4.2 contains backward incompatible changes with respect to v0.3.1. Therefore, you cannot mix analyses performed with the two releases.
 
 **COMPATIBILITY OF MAGIC-CTA-PIPE WITH LSTCHAIN DATA**
 
-At the moment of the release v0.4.1 of *magic-cta-pipe*, some LST-1 data are processed with *cta-lstchain* v0.9.x,
-while the most recent ones are processed with v0.10.x.
-According to this, if you need to analyze joint data where the version of LST-1 data is different, then:
+At the moment of the release v0.4.2 of *magic-cta-pipe*, some LST-1 data are processed with *cta-lstchain* v0.9.x,
+   while the most recent ones are processed with v0.10.x. v0.4.2 of *magic-cta-pipe* allows to read in LST data files
+   created with both v0.9.x and v0.10.x, so that you do not need to use different versions of *magic-cta-pipe* to
+   process LST data.
 
-* if LST-1 data were processed with *cta-lstchain* v0.9.x, you need to use *magic-cta-pipe* v0.3.1
-* if LST-1 data were processed with *cta-lstchain* v0.10.x, you need to use *magic-cta-pipe* v0.4.1
-
-Note that there are quite a lot of differences between v0.3.1 and v0.4.1, like for the telescope combinations definition,
-the way IRF are created (due to different *pyirf* versions) and so on. Therefore it may not be straightforward to stack the
-data at high level. Once all the LST-1 DL1 data will be reprocessed, *magic-cta-pipe* v0.4.1 will be the only version to use
-for the joint analysis.
+   Note that there are quite a lot of differences between v0.3.1 and v0.4.x, like for the telescope combinations definition,
+   the way IRF are created (due to different *pyirf* versions) and so on. Therefore it may not be straightforward to stack the
+   data at high level. We recommend to use only v0.4.2 for the processing, so that there will be no mismatches during the analysis.
 
 Installation for users
 ----------------------

docs/_static/switcher.json

@@ -9,6 +9,11 @@
         "version": "stable",
         "url": "https://magic-cta-pipe.readthedocs.io/en/stable/"
     },
+    {
+        "name": "v0.4.2",
+        "version": "v0.4.2",
+        "url": "https://magic-cta-pipe.readthedocs.io/en/v0.4.2/"
+    },
     {
         "name": "v0.4.1",
         "version": "v0.4.1",

docs/index.rst

@@ -27,17 +27,14 @@ Check out the :doc:`user-guide/index` section for the analysis steps, including
 
 .. note::
 
-   At the moment of the release v0.4.1 of *magic-cta-pipe*, some LST-1 data are processed with *cta-lstchain* v0.9.x,
-   while the most recent ones are processed with v0.10.x.
-   According to this, if you need to analyze joint data where the version of LST-1 data is different, then:
+   At the moment of the release v0.4.2 of *magic-cta-pipe*, some LST-1 data are processed with *cta-lstchain* v0.9.x,
+   while the most recent ones are processed with v0.10.x. v0.4.2 of *magic-cta-pipe* allows to read in LST data files
+   created with both v0.9.x and v0.10.x, so that you do not need to use different versions of *magic-cta-pipe* to
+   process LST data.
 
-   * if LST-1 data were processed with *cta-lstchain* v0.9.x, you need to use *magic-cta-pipe* v0.3.1
-   * if LST-1 data were processed with *cta-lstchain* v0.10.x, you need to use *magic-cta-pipe* v0.4.1
-
-   Note that there are quite a lot of differences between v0.3.1 and v0.4.1, like for the telescope combinations definition,
+   Note that there are quite a lot of differences between v0.3.1 and v0.4.x, like for the telescope combinations definition,
    the way IRF are created (due to different *pyirf* versions) and so on. Therefore it may not be straightforward to stack the
-   data at high level. Once all the LST-1 DL1 data will be reprocessed, *magic-cta-pipe* v0.4.1 will be the only version to use
-   for the joint analysis.
+   data at high level. We recommend to use only v0.4.2 for the processing, so that there will be no mismatches during the analysis.
 
 Contents
 --------