gammapyxray-fork

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

Repository

README.rst

Caveat: this is a work in progress. More details and examples will be added here

GammapyXray 
=======
A Python tool for the analysis of Gamma-ray and X-ray data in a unified framework, using physically-motivated spectral models.

The scripts provided in this folder are built on Numpy, Scipy, Astropy, Gammapy, Naima, Sherpa and Xspec. A software description is provided in the following publication: TBD

Installation and Set-up
+++++++++++++++++++++++++++++++++++++++++++++
These instructions assume that you have previously installed a version of `Anaconda `_ or `Miniconda `_ on your machine.

Set-up the work environment with conda::

  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

`Install JupyterLab or Jupyter Notebook `_ (recommended). 

If you need to use the physical models provided by `Naima `_, follow `these instructions `_ (optional).

Download the ZIPped contents of this folder directly from the main GitHub `page `_, or equivalently from the `Zenodo `_ or `Software Heritage `_ archives. Extract under your home directory::

  cd
  unzip ~/Downloads/gammapyXray-main.zip
  
To check that the installation has succeeded and start using the package, navigate to the ``gammapyXray-main`` folder and try to execute the example notebook::

  cd gammapyXray-main
  jupyter notebook example_nb.ipynb 
  
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 it using the following links

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4701488.svg?style=flat
    :target: TBD
.. image:: https://archive.softwareheritage.org/badge/swh:1:dir:02e8a702ef6c9558a9f96d99bf6b9f41b5edcd34/
    :target: TBD

We encourage you to also include citations to the paper in the main text
wherever appropriate, using the recommended BibTeX entry:

Bibtex

Contributing Code and Feedback
+++++++++++++++++++++++++++++++++++++++++++++
.. image:: https://img.shields.io/github/issues-pr/registerrier/gammapy-ogip-spectra
    :target: https://github.com/registerrier/gammapy-ogip-spectra/pulls
.. image:: https://img.shields.io/github/issues-pr-closed/registerrier/gammapy-ogip-spectra    
    :target: https://github.com/registerrier/gammapy-ogip-spectra/pulls


.. image:: https://img.shields.io/github/issues/registerrier/gammapy-ogip-spectra
    :target: https://github.com/registerrier/gammapy-ogip-spectra/issues
.. image:: https://img.shields.io/github/issues-closed/registerrier/gammapy-ogip-spectra?color=yellow    
    :target: https://github.com/registerrier/gammapy-ogip-spectra/issues

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

.. image:: https://anaconda.org/conda-forge/gammapy/badges/license.svg
    :target: TBD
    :alt: Licence

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: TBD
    description: Zenodo
  - type: swh
    value: TBD
    description: Software Heritage
  - type: doi
    value: TBD
    description: Related paper
abstract: TBD
keywords:
  - ''
license: BSD-3-Clause

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/registerrier/gammapyXray",
  "datePublished": "TBD YYYY-MM-DD",
  "issueTracker": "https://github.com/registerrier/gammapyXray/issues",
  "name": "gammapyXray",
  "version": "0.1",
  "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"
  ],
  "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: 8 months ago

Issues and Pull Requests

Last synced: 8 months ago