Metadata-Version: 2.4
Name: ebltable
Version: 0.6.4.dev3
Summary: Python code to read in and interpolate tables for absorption of high energy gamma rays with additional helper functions
Home-page: https://github.com/me-manu/ebltable
Author: Manuel Meyer
Author-email: me.manu@gmx.net
License: BSD
Keywords: extragalactic backgroun light,Fermi,IACT,EBL,gamma-ray,absorption,opacity,LIV,Lorentz invariance violation
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy>=1.19
Requires-Dist: scipy>=1.5
Requires-Dist: astropy>=4.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

ebltable
========

.. image:: https://img.shields.io/pypi/v/ebltable
    :target: https://pypi.org/project/ebltable/
    :alt: Latest Release

.. image:: https://github.com/me-manu/ebltable/actions/workflows/python_publish.yml/badge.svg
    :target: https://github.com/me-manu/ebltable/actions/workflows/python_publish.yml
    :alt: Build

.. image:: https://img.shields.io/github/license/me-manu/ebltable
    :target: https://github.com/me-manu/ebltable
    :alt: License
    
.. image:: https://img.shields.io/github/issues/me-manu/ebltable
    :target: https://github.com/me-manu/ebltable/issues
    :alt: Issues

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

Python packages to read in and interpolate tables for the photon density
of the Extragalactic Background Light (EBL) and the resulting opacity
for high energy gamma rays.

Prerequisites
-------------

Python 3.5 or higher and the following packages: 
    - numpy 
    - scipy
    - astropy

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

You can use pip to install the package:: 

    pip install ebltable

Example scripts and notebooks are provided on the github page in the
example/ and notebooks/ folder, https://github.com/me-manu/ebltable

Adding a New EBL Model
----------------------

If you would like to have your EBL model included in ebltable, please
`open a GitHub issue <https://github.com/me-manu/ebltable/issues>`_ and include
the following information:

1. **State your request** — briefly mention that you would like your model added.

2. **Provide a paper reference** — include the full citation or a link to the
   publication describing the EBL model (e.g. arXiv ID or DOI).

3. **Upload the data files** — attach two ASCII tables to the issue:

   *EBL intensity table*
      An *n* × *m* matrix of EBL intensities νI\ :sub:`ν` [nW m\ :sup:`-2` sr\ :sup:`-1`]
      for *n* redshifts and *m* wavelengths (in µm).
      The table must include a column for *z* = 0.
      See `ebl_saldana21_comoving.txt
      <https://github.com/me-manu/ebltable/blob/main/ebltable/data/ebl_saldana21_comoving.txt>`_
      for a worked example of the expected layout.

   *Optical depth table*
      An *n* × *m* matrix of optical depth values τ for *n* redshifts and
      *m* gamma-ray energies (in TeV or GeV — please specify the unit).
      See `ebl_dominguez11.out
      <https://github.com/me-manu/ebltable/blob/main/ebltable/data/ebl_dominguez11.out>`_
      for a worked example of the expected layout.

License
-------
ebltable is distributed under the modified BSD License.
