Data

Tools

Indexes

Applications

Experiments

Open Source Science

hendrics

Shell scripts for spectral-timing analysis of X-ray astronomical data.

https://github.com/stingraysoftware/hendrics

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: arxiv.org, iop.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.8%) to scientific vocabulary

Keywords

astronomy astrophysics blackholes hacktoberfest neutron-star opensource pulsars timeseries
Last synced: 6 months ago · JSON representation ·

Repository

Shell scripts for spectral-timing analysis of X-ray astronomical data.

Basic Info
  • Host: GitHub
  • Owner: StingraySoftware
  • License: other
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage: http://hendrics.readthedocs.io
  • Size: 44.6 MB
Statistics
  • Stars: 25
  • Watchers: 5
  • Forks: 15
  • Open Issues: 16
  • Releases: 9
Topics
astronomy astrophysics blackholes hacktoberfest neutron-star opensource pulsars timeseries
Created over 8 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.rst 

|Build Status| |Coverage Status| |Documentation Status|

HENDRICS - High ENergy Data Reduction Interface from the Command Shell
======================================================================

Description
-----------

This set of command-line scripts based on
`Stingray `__ is designed
to do correctly and fairly easily a **quick-look (spectral-)timing
analysis** of X-ray data, treating properly the gaps in the data due,
e.g., to occultation from the Earth or passages through the SAA.
Originally, its development as MaLTPyNT - Matteo's Libraries and Tools
in Python for NuSTAR Timing - was driven by the need of performing
aperiodic timing analysis on NuSTAR data, whose long dead time made it
difficult to treat power density spectra with the usual tools. By
exploiting the presence of two independent detectors, one could use the
**cospectrum** as a proxy for the power density spectrum (for an
explanation of why this is important, look at Bachetti et al., *ApJ*,
800, 109 -`arXiv:1409.3248 `__).

Today, this set of command line scripts is much more complete and it is
capable of working with the data of many more satellites. Among the
features already implemented are power density and cross spectra, time
lags, pulsar searches with the Epoch folding and the Z\_n^2 statistics,
color-color and color-intensity diagrams. More is in preparation:
rms-energy, lag-energy, covariance-energy spectra, Lomb-Scargle
periodograms and in general all that is available in
`Stingray `__. The
analysis done in HENDRICS will be compatible with the graphical user
interface `DAVE `__, so that
users will have the choice to analyze single datasets with an easy
interactive interface, and continue the analysis in batch mode with
HENDRICS. The periodograms produced by HENDRICS (like a power density
spectrum or a cospectrum), can be saved in a format compatible with
``XSpec`` or ``ISIS``, for
those who are familiar with those fitting packages. Despite its original
main focus on NuSTAR, the software can be used to make standard
aperiodic timing analysis on X-ray data from, in principle, any other
satellite (for sure XMM-Newton and RXTE).

The **documentation** can be found
`here `__.

A **tutorial** is also available
`here `__.

Installation instructions
-------------------------

To install stable or beta releases:

::

    $ pip install hendrics

For development versions:

::

    $ git clone git@github.com/StingraySoftware/HENDRICS
    $ cd HENDRICS
    $ python setup.py install


License and notes for the users
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This software is released with a 3-clause BSD license. You can find
license information in the ``LICENSE.rst`` file.

**If you use this software in a publication**, please refer to its
Astrophysics Source Code Library identifier:

1. Bachetti, M. 2018, HENDRICS: High ENergy Data Reduction Interface from the Command Shell, record `ascl:1805.019 `__.

and please also cite `stingray `

In particular, **if you use the cospectrum**, please also refer to:

2. Bachetti et al. 2015, `ApJ `__ , **800**, 109.

If you have found a bug please report it by creating a
new issue on the `HENDRICS GitHub issue tracker. `_

Development guidelines
----------------------

Please follow the development workflow for
`the Astropy project `__.
In the hendrics/tests
directory, there is a test suite called ``test_fullrun.py``. These tests
use the actual command line scripts, and should always pass (albeit with
some adaptations). The other test suites, e.g. ``test_unit.py``, tests
the API.

.. |Build Status| image:: https://github.com/StingraySoftware/HENDRICS/workflows/CI%20Tests/badge.svg
    :target: https://github.com/StingraySoftware/HENDRICS/actions/
.. |Coverage Status| image:: https://codecov.io/gh/StingraySoftware/HENDRICS/branch/main/graph/badge.svg
  :target: https://app.codecov.io/gh/StingraySoftware/HENDRICS
.. |Documentation Status| image:: https://readthedocs.org/projects/hendrics/badge/?version=main
   :target: https://hendrics.readthedocs.io/en/main/?badge=main

Owner

  • Name: Stingray
  • Login: StingraySoftware
  • Kind: organization

Next-generation spectral-timing software for astronomy applications and beyond.

Citation (CITATION) 

If you use this software in a publication, please refer to its Astrophysics Source Code Library identifier:

    Bachetti, M. 2015, MaLTPyNT, Astrophysics Source Code Library, record ascl:1502.021.

In particular, if you use the cospectrum, please also refer to:

    Bachetti et al. 2015, ApJ , 800, 109.

@MISC{2015ascl.soft02021B,
   author = {{Bachetti}, M.},
    title = "{MaLTPyNT: Quick look timing analysis for NuSTAR data}",
 keywords = {Software},
howpublished = {Astrophysics Source Code Library},
     year = 2015,
    month = feb,
archivePrefix = "ascl",
   eprint = {1502.021},
   adsurl = {https://adsabs.harvard.edu/abs/2015ascl.soft02021B},
  adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@ARTICLE{2015ApJ...800..109B,
   author = {{Bachetti}, M. and {Harrison}, F.~A. and {Cook}, R. and {Tomsick}, J. and
	{Schmid}, C. and {Grefenstette}, B.~W. and {Barret}, D. and
	{Boggs}, S.~E. and {Christensen}, F.~E. and {Craig}, W.~W. and
	{Fabian}, A.~C. and {F{\"u}rst}, F. and {Gandhi}, P. and {Hailey}, C.~J. and
	{Kara}, E. and {Maccarone}, T.~J. and {Miller}, J.~M. and {Pottschmidt}, K. and
	{Stern}, D. and {Uttley}, P. and {Walton}, D.~J. and {Wilms}, J. and
	{Zhang}, W.~W.},
    title = "{No Time for Dead Time: Timing Analysis of Bright Black Hole Binaries with NuSTAR}",
  journal = {\apj},
archivePrefix = "arXiv",
   eprint = {1409.3248},
 primaryClass = "astro-ph.HE",
 keywords = {accretion, accretion disks, black hole physics, methods: data analysis, methods: statistical, X-rays: stars},
     year = 2015,
    month = feb,
   volume = 800,
      eid = {109},
    pages = {109},
      doi = {10.1088/0004-637X/800/2/109},
   adsurl = {https://adsabs.harvard.edu/abs/2015ApJ...800..109B},
  adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

GitHub Events

Total
  • Create event: 10
  • Issues event: 4
  • Release event: 2
  • Watch event: 2
  • Delete event: 4
  • Issue comment event: 9
  • Push event: 31
  • Pull request review event: 7
  • Pull request review comment event: 6
  • Pull request event: 16
  • Fork event: 3
Last Year
  • Create event: 10
  • Issues event: 4
  • Release event: 2
  • Watch event: 2
  • Delete event: 4
  • Issue comment event: 9
  • Push event: 31
  • Pull request review event: 7
  • Pull request review comment event: 6
  • Pull request event: 16
  • Fork event: 3

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 34
  • Total pull requests: 100
  • Average time to close issues: 5 months
  • Average time to close pull requests: 15 days
  • Total issue authors: 19
  • Total pull request authors: 6
  • Average comments per issue: 1.44
  • Average comments per pull request: 0.71
  • Merged pull requests: 85
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 19
  • Average time to close issues: about 22 hours
  • Average time to close pull requests: 6 days
  • Issue authors: 3
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.26
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • matteobachetti (8)
  • giallixx (5)
  • gjmlunaIAFE (3)
  • pllim (2)
  • paulray (2)
  • hemanth-mmk (1)
  • ellot (1)
  • princerajsharma31 (1)
  • fcotizelati (1)
  • jdswinbank (1)
  • mckinley-brumback (1)
  • Gwenloyer (1)
  • nx1 (1)
  • ferrigno (1)
  • Alistair-P (1)
Pull Request Authors
  • matteobachetti (98)
  • Sudarshan-21 (6)
  • fcotizelati (2)
  • YaoYLastro (2)
  • bsipocz (1)
  • jdswinbank (1)
Top Labels
Issue Labels
bug (10) enhancement (3)
Pull Request Labels
no-changelog-entry-needed (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 761 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 37
  • Total maintainers: 2
pypi.org: hendrics

High ENergy Data Reduction Interface from the Command Shell

  • Versions: 31
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 761 Last month
Rankings
Dependent packages count: 10.1%
Average: 20.1%
Dependent repos count: 21.6%
Downloads: 28.8%
Maintainers (2)
dhuppenkothen mbachett
Last synced: 6 months ago
conda-forge.org: hendrics

This Astropy-affiliated software package is designed to do correctly and fairly easily a **quick-look (spectral-) timing analysis** of X-ray data, including most of the functionality implemented in stingray (github.com/stingraysoftware/stingray), but from the command line, starting from mission-specific event files (NuSTAR, RXTE, XMM, and more).

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Forks count: 42.2%
Average: 43.0%
Stargazers count: 44.6%
Dependent packages count: 51.2%
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • astropy *
  • matplotlib *
  • numpy *
  • scipy *
  • sphinx-astropy *
  • stingray >=1.0b0
.github/workflows/ci_test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
pyproject.toml pypi
setup.py pypi