Metadata-Version: 2.4
Name: dl1_data_handler
Version: 0.14.4
Summary: A package of utilities for reading, and applying image processing to Cherenkov Telescope Array (CTA) R1/DL0/DL1 data in a standardized format. Created primarily for testing machine learning image analysis techniques on IACT data.
Author: Ari Brill, Bryan Kim, Tjark Miener
Author-email: Daniel Nieto <d.nieto@ucm.es>
License: BSD-3-Clause
Project-URL: repository, https://github.com/cta-observatory/dl1-data-handler
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: ctapipe<0.26,>=0.22
Requires-Dist: astropy
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pip
Requires-Dist: pyyaml
Requires-Dist: scipy
Requires-Dist: traitlets
Requires-Dist: pydot
Requires-Dist: setuptools
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-rtd-theme; extra == "doc"
Provides-Extra: all
Requires-Dist: dl1_data_handler[doc]; extra == "all"
Dynamic: license-file

DL1 Data Handler
================


.. image:: https://zenodo.org/badge/72042185.svg
   :target: https://zenodo.org/badge/latestdoi/72042185
   :alt: DOI


.. image:: https://anaconda.org/ctlearn-project/dl1_data_handler/badges/version.svg
   :target: https://anaconda.org/ctlearn-project/dl1_data_handler/
   :alt: Anaconda-Server Badge


.. image:: https://img.shields.io/pypi/v/dl1-data-handler
    :target: https://pypi.org/project/dl1-data-handler/
    :alt: Latest Release


.. image:: https://github.com/cta-observatory/dl1-data-handler/actions/workflows/python-package-conda.yml/badge.svg
    :target: https://github.com/cta-observatory/dl1-data-handler/actions/workflows/python-package-conda.yml
    :alt: Continuos Integration

A package of utilities for reading and applying image processing to `Cherenkov Telescope Array Observatory (CTAO) <https://www.ctao.org/>`_ R1/DL0/DL1 data in a standardized format. Created primarily for testing machine learning image analysis techniques on IACT data.

Currently supports ctapipe  >= v6.0.0 data format. 

Previously named image-extractor (v0.1.0 - v0.6.0). Currently under development, intended for internal use only.


Installation
------------

The following installation method (for Linux) is recommended:

Installing as a conda package
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To install dl1-data-handler as a conda package, first install Anaconda by following the instructions here: https://www.anaconda.com/distribution/.

The following command will set up a conda virtual environment, add the
necessary package channels, and install dl1-data-handler specified version and its dependencies:

.. code-block:: bash

   DL1DH_VER=0.14.4
   wget https://raw.githubusercontent.com/cta-observatory/dl1-data-handler/v$DL1DH_VER/environment.yml
   conda env create -n [ENVIRONMENT_NAME] -f environment.yml
   conda activate [ENVIRONMENT_NAME]
   conda install -c ctlearn-project dl1_data_handler=$DL1DH_VER

This should automatically install all dependencies (NOTE: this may take some time, as by default MKL is included as a dependency of NumPy and it is very large).


Links
-----


* `Cherenkov Telescope Array Observatory (CTAO) <https://www.ctao.org/>`_ - Homepage of the CTA Observatory
* `CTLearn <https://github.com/ctlearn-project/ctlearn/>`_ and `GammaLearn <https://gitlab.lapp.in2p3.fr/GammaLearn/GammaLearn>`_ - Repository of code for studies on applying deep learning to IACT analysis tasks. Maintained by groups at Universidad Complutense de Madrid, University of Geneva (CTLearn) and LAPP (GammaLearn).
* `ctapipe <https://cta-observatory.github.io/ctapipe/>`_ - Official documentation for the ctapipe analysis package (in development)

