==============
magic-cta-pipe
==============
.. container::
|Actions Status| |PyPI 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.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.
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.
**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.
Installation for users
----------------------
*magic-cta-pipe* and its dependencies may be installed using the *Anaconda* or *Miniconda* package system. We recommend creating a conda virtual environment
first, to isolate the installed version and dependencies from your master environment (this is optional).
The following command will set up a conda virtual environment, add the necessary package channels, and install *magic-cta-pipe* and its dependencies::
git clone https://github.com/cta-observatory/magic-cta-pipe.git
cd magic-cta-pipe
conda env create -n magic-lst1 -f environment.yml
conda activate magic-lst1
pip install .
In general, *magic-cta-pipe* is still in heavy development phase, so expect large changes between different releases.
Instructions for developers
---------------------------
Developers should follow the development install instructions found in the
`documentation <https://magic-cta-pipe.readthedocs.io/en/latest/developer-guide/getting-started.html>`_.
.. |Actions Status| image:: https://github.com/cta-observatory/magic-cta-pipe/actions/workflows/ci.yml/badge.svg?branch=master
:target: https://github.com/cta-observatory/magic-cta-pipe/actions
:alt: magic-cta-pipe GitHub Actions CI Status
.. |PyPI Status| image:: https://badge.fury.io/py/magic-cta-pipe.svg
:target: https://pypi.org/project/magic-cta-pipe
:alt: magic-cta-pipe PyPI 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
.. |Pre-Commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
.. |isort Status| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
:target: https://pycqa.github.io/isort/
:alt: isort Status
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
Raw data
{
"_id": null,
"home_page": "https://github.com/cta-observatory/magic-cta-pipe",
"name": "magic-cta-pipe",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "magic-cta-pipe developers",
"author_email": "alessioberti90@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/25/0b/172ff2693ef36e06a3a44f6d29af15fb9ca5e8a97d24752cd8670ab0e062/magic-cta-pipe-0.4.1.tar.gz",
"platform": null,
"description": "==============\nmagic-cta-pipe\n==============\n\n.. container::\n\n |Actions Status| |PyPI Status| |Documentation Status| |Pre-Commit| |isort Status| |black|\n\nRepository for the analysis of MAGIC and MAGIC+LST1 data, based on `ctapipe <https://github.com/cta-observatory/ctapipe>`_.\n\n* Code: https://github.com/cta-observatory/magic-cta-pipe\n* Docs (preliminary): https://magic-cta-pipe.readthedocs.io/\n\nv0.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.\nSee `here <https://magic-cta-pipe.readthedocs.io/en/latest/user-guide/magic-lst-scripts.html>`_ for more details on how to run the analysis.\n\nv0.4.1 is based on *ctapipe* v0.19.x and *cta-lstchain* v0.10.x.\n\n**NOTE ON OLD RELEASES**\n\nv0.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.\nIn order to exploit fully the new functionalities provided by *ctapipe*, use always the latest stable release of *magic-cta-pipe* (currently v0.4.1).\nv0.4.1 contains backward incompatible changes with respect to v0.3.1. Therefore, you cannot mix analyses performed with the two releases.\n\nInstallation for users\n----------------------\n\n*magic-cta-pipe* and its dependencies may be installed using the *Anaconda* or *Miniconda* package system. We recommend creating a conda virtual environment\nfirst, to isolate the installed version and dependencies from your master environment (this is optional).\n\nThe following command will set up a conda virtual environment, add the necessary package channels, and install *magic-cta-pipe* and its dependencies::\n\n git clone https://github.com/cta-observatory/magic-cta-pipe.git\n cd magic-cta-pipe\n conda env create -n magic-lst1 -f environment.yml\n conda activate magic-lst1\n pip install .\n\nIn general, *magic-cta-pipe* is still in heavy development phase, so expect large changes between different releases.\n\nInstructions for developers\n---------------------------\n\nDevelopers should follow the development install instructions found in the\n`documentation <https://magic-cta-pipe.readthedocs.io/en/latest/developer-guide/getting-started.html>`_.\n\n.. |Actions Status| image:: https://github.com/cta-observatory/magic-cta-pipe/actions/workflows/ci.yml/badge.svg?branch=master\n :target: https://github.com/cta-observatory/magic-cta-pipe/actions\n :alt: magic-cta-pipe GitHub Actions CI Status\n\n.. |PyPI Status| image:: https://badge.fury.io/py/magic-cta-pipe.svg\n :target: https://pypi.org/project/magic-cta-pipe\n :alt: magic-cta-pipe PyPI Status\n\n.. |Documentation Status| image:: https://readthedocs.org/projects/magic-cta-pipe/badge/?version=latest&style=flat\n :target: https://magic-cta-pipe.readthedocs.io/en/latest/\n :alt: magic-cta-pipe documentation Status\n\n.. |Pre-Commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n :target: https://github.com/pre-commit/pre-commit\n :alt: pre-commit\n\n.. |isort Status| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\n :target: https://pycqa.github.io/isort/\n :alt: isort Status\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "pipeline for the analysis of joint MAGIC+LST-1 data",
"version": "0.4.1",
"project_urls": {
"Bug Tracker": "https://github.com/cta-observatory/magic-cta-pipe/issues",
"Homepage": "https://github.com/cta-observatory/magic-cta-pipe",
"Source Code": "https://github.com/cta-observatory/magic-cta-pipe"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5536172fbc162b6290ccae519bce3b5f1d88666fb5b2a59875e69adb98d10e3c",
"md5": "d8a08ea872792a89a17b9b0bcf826363",
"sha256": "65597cefda0ca37017c45f3fda236cb2191c9927c961a2b8f6b35a7c30b867ae"
},
"downloads": -1,
"filename": "magic_cta_pipe-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8a08ea872792a89a17b9b0bcf826363",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 96966,
"upload_time": "2024-01-22T18:43:19",
"upload_time_iso_8601": "2024-01-22T18:43:19.971704Z",
"url": "https://files.pythonhosted.org/packages/55/36/172fbc162b6290ccae519bce3b5f1d88666fb5b2a59875e69adb98d10e3c/magic_cta_pipe-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "250b172ff2693ef36e06a3a44f6d29af15fb9ca5e8a97d24752cd8670ab0e062",
"md5": "67cf3d921f12623dfbafbf5ae95cb9fb",
"sha256": "8a134c4de9c3c30f61f5186eaa62d321753b8876b152b0db613c3d96434ef9c8"
},
"downloads": -1,
"filename": "magic-cta-pipe-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "67cf3d921f12623dfbafbf5ae95cb9fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 2594676,
"upload_time": "2024-01-22T18:43:21",
"upload_time_iso_8601": "2024-01-22T18:43:21.921495Z",
"url": "https://files.pythonhosted.org/packages/25/0b/172ff2693ef36e06a3a44f6d29af15fb9ca5e8a97d24752cd8670ab0e062/magic-cta-pipe-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-22 18:43:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cta-observatory",
"github_project": "magic-cta-pipe",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "magic-cta-pipe"
}
JSON
