gammapyxray

A Python code for X-ray and Gamma-ray Astronomy based on Gammapy

https://github.com/luca-giunti/gammapyxray

Repository

A Python code for X-ray and Gamma-ray Astronomy based on Gammapy

README.rst

GammapyXray 
==========

A Python code for the spectral analysis of Gamma-ray and X-ray data in a unified framework, using physically-motivated spectral models. The data handling and fitting relies on the Gammapy architecture, while the multi-wavelength spectral modeling can be performed using an arbitrary combination of the functions included in the Gammapy, Xspec and Naima libraries.
   
This code is built on Numpy, Scipy, Astropy, Gammapy, Naima, Sherpa and Xspec. A working example is provided in the ``tutorial.ipynb`` notebook.

If you wish to give us your feedback, report bugs or ask for help please open an issue or send us an email.

.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
    :target: http://www.astropy.org/
.. image:: https://anaconda.org/conda-forge/gammapy/badges/installer/conda.svg
.. image:: https://zenodo.org/badge/533655451.svg
   :target: https://zenodo.org/badge/latestdoi/533655451

Citing
+++++++++++++++++++++++++++++++++++++++++++++


If you use GammapyXray for work/research presented in a publication (whether directly, or as a dependency to another package), we ask that you please cite:

.. image:: https://zenodo.org/badge/533655451.svg
   :target: https://zenodo.org/badge/latestdoi/533655451


Installation and Set-up
+++++++++++++++++++++++++++++++++++++++++++++
These instructions assume that you have previously installed a version of `Anaconda `_ or `Miniconda `_ on your machine. Optionally, if you want to speed up the installation, you can also use `Mamba `_. In that case, simply install it using::

  conda install mamba -n base -c conda-forge 
  
and substitute all the occurrences of the ``conda`` command with ``mamba`` in the following steps. 

- Set-up the work environment::

    conda create -n gammapyXray
    conda activate gammapyXray
    conda install -c https://cxc.cfa.harvard.edu/conda/ciao -c conda-forge ciao sherpa
    conda install -c conda-forge gammapy=0.20.1
  
- `Install JupyterLab or Jupyter Notebook `_ (recommended). 

- If you need to use physically-motivated radiative models, install `Naima `_ following `these instructions `_ (optional, but needed to run the ``tutorial.ipynb``).

- Download the ZIPped contents of this folder directly from the main GitHub `page `_, or equivalently from the `Zenodo `_ archive. Then extract under your home or work directory and navigate to the ``gammapyXray-0.1`` folder

- Check that the installation has succeeded and start using the package, executing the tutorial notebook::

    jupyter notebook tutorial.ipynb 


Testing
+++++++++++++++++++++++++

If you wish to execute the tests associated to this code (using `pytest `_) you need to:

- set up the ``XMM_DATA`` environment variable::

    export XMM_DATA=/gammapyXray/XMM_test_files/
- run pytest from the ``gammapyXray`` folder::

    pytest gammapyXray/tests/test_models.py
    pytest gammapyXray/tests/test_ogip_spectrum_dataset.py 

Licence
+++++++
This folder is licensed under a 3-clause BSD style license - see the
`LICENSE.rst `_ file.

Owner

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: gammapyXray
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Luca
    family-names: Giunti
    email: giunti@apc.in2p3.fr
    affiliation: 'APC (Paris, CNRS/IN2P3)'
    orcid: 'https://orcid.org/0000-0002-3395-3647'
  - given-names: Regis
    family-names: Terrier
    email: rterrier@apc.in2p3.fr
    affiliation: 'APC (Paris, CNRS/IN2P3)'
    orcid: 'https://orcid.org/0000-0002-8219-4667'
identifiers:
  - type: doi
    value: https://doi.org/10.5281/zenodo.7092736
    description: Zenodo
license: BSD-3-Clause
url: https://doi.org/10.5281/zenodo.7092736

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "license": "https://spdx.org/licenses/BSD-3-Clause",
  "codeRepository": "https://github.com/luca-giunti/gammapyXray",
  "datePublished": "TBD YYYY-MM-DD",
  "issueTracker": "https://github.com/luca-giunti/gammapyXray/issues",
  "name": "gammapyXray",
  "description": "A Python tool for the analysis of Gamma-ray and X-ray data in a unified framework, using physically-motivated spectral models.",
  "applicationCategory": "Astronomy",
  "developmentStatus": "active",
  "isPartOf": "https://gammapy.org/",
  "referencePublication": "https://TBD",
  "keywords": [
    "Astronomy",
    "High-energy Astrohpysics",
    "Gamma-ray",
    "X-ray",
    "Multi-wavelength",
    "Multiwavelength",
    "Gammapy",
    "Sherpa",
    "Naima",
    "Python",
    "Modeling",
    "Data analysis"
  ],
  "programmingLanguage": [
    "Python 3"
  ],
  "softwareRequirements": [
    "Anaconda/Miniconda",
    "Gammapy",
    "Sherpa",
    "Naima"
  ],
  "author": [
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0002-3395-3647",
      "givenName": "Luca",
      "familyName": "Giunti",
      "email": "giunti@apc.in2p3.fr",
      "affiliation": {
        "@type": "Organization",
        "name": "APC (Paris, CNRS/IN2P3)"
      }
    },
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0002-8219-4667",
      "givenName": "Regis",
      "familyName": "Terrier",
      "email": "rterrier@apc.in2p3.fr",
      "affiliation": {
        "@type": "Organization",
        "name": "APC (Paris, CNRS/IN2P3)"
      }
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "@id": "https://orcid.org/0000-0001-6876-5577",
      "givenName": "Bruno",
      "familyName": "Khelifi",
      "email": "khelifi@apc.in2p3.fr",
      "affiliation": {
        "@type": "Organization",
        "name": "APC (Paris, CNRS/IN2P3)"
      }
    }
  ]
}

GitHub Events

Committers

Last synced: 9 months ago

Issues and Pull Requests

Last synced: 8 months ago