Skip to content

Commit

Permalink
Merge pull request #251 from cta-observatory/update_requirements
Browse files Browse the repository at this point in the history
Update requirements
  • Loading branch information
aleberti authored Sep 3, 2024
2 parents 9af1ff0 + c980215 commit 01f273d
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 16 deletions.
20 changes: 12 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,34 @@ magic-cta-pipe

.. container::

|Actions Status| |PyPI Status| |Documentation Status| |Pre-Commit| |isort Status| |black|
|Actions Status| |PyPI Status| |Conda Status| |Documentation Status| |Pre-Commit| |isort Status| |black|

Repository for the analysis of MAGIC and MAGIC+LST1 data, based on `ctapipe <https://github.com/cta-observatory/ctapipe>`_.

* Code: https://github.com/cta-observatory/magic-cta-pipe
* Docs (preliminary): https://magic-cta-pipe.readthedocs.io/

v0.5.0 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.5.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.
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.5.0 is based on *ctapipe* v0.19.x and *cta-lstchain* v0.10.x.
v0.5.1 is based on *ctapipe* v0.19.x and *cta-lstchain* v0.10.x (with 5<=x<12).

**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.5.0).
v0.5.0 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.5.1).
v0.5.1 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.5.0 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.5.0 of *magic-cta-pipe* allows to read in LST data files
At the moment of the release v0.5.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. v0.5.1 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.

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.5.0 for the processing, so that there will be no mismatches during the analysis.
data at high level. We recommend to use only v0.5.1 for the processing, so that there will be no mismatches during the analysis.

Installation for users
----------------------
Expand Down Expand Up @@ -65,6 +65,10 @@ Developers should follow the development install instructions found in the
:target: https://pypi.org/project/magic-cta-pipe
:alt: magic-cta-pipe PyPI Status

.. |Conda Status| image:: https://anaconda.org/conda-forge/magic-cta-pipe/badges/version.svg
:target: https://anaconda.org/conda-forge/magic-cta-pipe
:alt: magic-cta-pipe Conda Status

.. |Documentation Status| image:: https://readthedocs.org/projects/magic-cta-pipe/badge/?version=latest&style=flat
:target: https://magic-cta-pipe.readthedocs.io/en/latest/
:alt: magic-cta-pipe documentation Status
Expand Down
5 changes: 5 additions & 0 deletions docs/_static/switcher.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
"version": "stable",
"url": "https://magic-cta-pipe.readthedocs.io/en/stable/"
},
{
"name": "v0.5.1",
"version": "v0.5.1",
"url": "https://magic-cta-pipe.readthedocs.io/en/v0.5.1/"
},
{
"name": "v0.5.0",
"version": "v0.5.0",
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ Check out the :doc:`user-guide/index` section for the analysis steps, including

.. note::

At the moment of the release v0.5.0 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.5.0 of *magic-cta-pipe* allows to read in LST data files
At the moment of the release v0.5.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. v0.5.1 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.

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.5.0 for the processing, so that there will be no mismatches during the analysis.
data at high level. We recommend to use only v0.5.1 for the processing, so that there will be no mismatches during the analysis.

Contents
--------
Expand Down
4 changes: 2 additions & 2 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ dependencies:
- pre-commit
- toml
- tomli
- protobuf=3.20
- protozfits=2.5
- pydata-sphinx-theme
- pyparsing
- psutil
Expand All @@ -48,4 +48,4 @@ dependencies:
- pymongo
- pyirf~=0.10.0
- ctapipe-io-magic~=0.5.4
- lstchain~=0.10.5
- lstchain>=0.10.5,<0.10.12
6 changes: 3 additions & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ python_requires = >=3.9
zip_safe = False
install_requires =
ctapipe ~=0.19.2
lstchain ~=0.10.5
lstchain >=0.10.5, <0.10.12
ctaplot ~=0.6.4
ctapipe_io_magic ~=0.5.4
gammapy ~=1.1
Expand All @@ -43,10 +43,10 @@ install_requires =
h5py
iminuit >=2
joblib ~=1.2.0
matplotlib ~=3.0
matplotlib ~=3.7
numba
numpy
protobuf ~=3.20.0
protozfits >=2.5,<3
scipy >=1.8, <1.12
scikit-learn ~=1.2
tables
Expand Down

0 comments on commit 01f273d

Please sign in to comment.