AltaiPony - Flare science in Kepler, K2 and TESS light curves

AltaiPony - Flare science in Kepler, K2 and TESS light curves - Published in JOSS (2021)

https://github.com/ekaterinailin/altaipony

Science Score: 95.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 19 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    2 of 6 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Engineering Computer Science - 60% confidence
Last synced: 6 months ago · JSON representation

Repository

Find flares in Kepler and TESS light curves. Notebooks for quickstart inside.

Basic Info
Statistics
  • Stars: 26
  • Watchers: 2
  • Forks: 12
  • Open Issues: 29
  • Releases: 5
Created over 7 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog License

README.rst

|docs-badge| |license-badge| |joss-badge| |zenodo-badge|


.. |joss-badge| image:: https://joss.theoj.org/papers/10.21105/joss.02845/status.svg
   :target: https://doi.org/10.21105/joss.02845

..  |zenodo-badge| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5040830.svg
                    :target: https://doi.org/10.5281/zenodo.5040830

.. |docs-badge| image:: https://readthedocs.org/projects/altaipony/badge/?version=latest
	      :target: https://altaipony.readthedocs.io/en/latest/?badge=latest
	      :alt: Documentation Status
	      
.. |license-badge|  image:: https://img.shields.io/github/license/mashape/apistatus.svg   
		    :target: https://github.com/ekaterinailin/AltaiPony/blob/master/LICENSE 
		    :alt: GitHub	

.. image:: logo.png
   :height: 100px
   :width: 100px
   :alt: Logo credit: Elizaveta Ilin, 2018

AltaiPony
=========

De-trend light curves from Kepler, and TESS missions, and search them for flares. Inject and recover synthetic flares to account for de-trending and noise loss in flare energy and determine energy-dependent recovery probability for every flare candidate. Uses ``lightkurve`` under the cover, as well as ``pandas``, ``numpy``, ``pytest``, ``astropy`` and more.

Find the documentation at altaipony.readthedocs.io_

Installation
^^^^^^^^^^^^^

Use pip to install AltaiPony

>>> pip install altaipony


Or install directly from the repository:

>>> git clone https://github.com/ekaterinailin/AltaiPony.git
>>> cd AltaiPony
>>> python setup.py install



Getting Started
^^^^^^^^^^^^^^^^

See this notebook_ for an easy introduction, also docs_.


Problems?
^^^^^^^^^

 Often, when something does not work in **AltaiPony**, and this documentation is useless, troubleshooting can be done by diving into the extensive **lightkurve** docs_. Otherwise, you can always shoot Ekaterina an email_ or directly open an issue on GitHub_. Many foreseeable problems will be due to bugs in **AltaiPony** or bad instructions on this website.


Contribute to AltaiPony
^^^^^^^^^^^^^^^^^^^^^^^

**AltaiPony** is under active development on Github_. If you use **AltaiPony** in your research and find yourself missing a functionality, I recommend opening an issue on GitHub_ or shooting Ekaterina an email_. Please do either of the two before you open a pull request. This may save you a lot of development time.

How to cite this work
^^^^^^^^^^^^^^^^^^^^^

If you end up using this package for your science, please cite Ilin et al. (2021) [a]_ and Davenport (2016) [b]_.

Please also cite `lightkurve` as indicated in their docs [1]_. 

Depending on the methods you use, you may also want to cite 

  - Maschberger and Kroupa (2009) [2]_ (MMLE power law fit)
  - Wheatland (2004) [3]_ (MCMC power law fit)
  - Aigrain et al. (2016) [4]_ and their software [5]_ (K2SC de-trending -- DEPRECATED)
  - Davenport et al. (2014) [6_] or Mendoza et al. (2022) [7_] (injection-recovery analysis)


.. [a] Ekaterina Ilin, Sarah J. Schmidt, Katja Poppenhäger, James R. A. Davenport, Martti H. Kristiansen, Mark Omohundro (2021). "Flares in Open Clusters with K2. II. Pleiades, Hyades, Praesepe, Ruprecht 147, and M67" Astronomy & Astrophysics, Volume 645, id.A42, 25 pp.  	https://doi.org/10.1051/0004-6361/202039198 

.. [b] James R. A. Davenport "The Kepler Catalog of Stellar Flares" The Astrophysical Journal, Volume 829, Issue 1, article id. 23, 12 pp. (2016). https://doi.org/10.3847/0004-637X/829/1/23

.. [1] https://docs.lightkurve.org/about/citing.html

.. [2] Thomas Maschberger, Pavel Kroupa, "Estimators for the exponent and upper limit, and goodness-of-fit tests for (truncated) power-law distributions" Monthly Notices of the Royal Astronomical Society, Volume 395, Issue 2, May 2009, Pages 931–942, https://doi.org/10.1111/j.1365-2966.2009.14577.x

.. [3] Wheatland, Michael S. "A Bayesian approach to solar flare prediction." The Astrophysical Journal 609.2 (2004): 1134. https://doi.org/10.1086/421261

.. [4] Aigrain, Suzanne; Parviainen, Hannu; Pope, Benjamin "K2SC: flexible systematics correction and detrending of K2 light curves using Gaussian process regression" Monthly Notices of the Royal Astronomical Society, Volume 459, Issue 3, p.2408-2419 https://doi.org/10.1093/mnras/stw706

.. [5] Aigrain, Suzanne; Parviainen, Hannu; Pope, Benjamin "K2SC: K2 Systematics Correction." Astrophysics Source Code Library, record ascl:1605.012 https://ui.adsabs.harvard.edu/abs/2016ascl.soft05012A/abstract

.. [6] J. R. A. Davenport et al., “Kepler Flares. II. The Temporal Morphology of White-light Flares on GJ 1243,” The Astrophysical Journal, vol. 797, p. 122, Dec. 2014, doi: 10.1088/0004-637X/797/2/122.

.. [7] G. T. Mendoza, J. R. A. Davenport, E. Agol, J. A. G. Jackman, and S. L. Hawley, “Llamaradas Estelares: Modeling the Morphology of White-light Flares,” The Astronomical Journal, Volume 164, Issue 1, id.17, 12 pp., vol. 164, no. 1, p. 17, Jul. 2022, doi: 10.3847/1538-3881/ac6fe6.




.. _Appaloosa: https://github.com/jradavenport/appaloosa/
.. _altaipony.readthedocs.io: https://altaipony.readthedocs.io/en/latest/
.. _notebook: https://github.com/ekaterinailin/AltaiPony/blob/master/notebooks/Getting_Started.ipynb
.. _docs: https://altaipony.readthedocs.io/en/latest/
.. _Github: https://github.com/ekaterinailin/AltaiPony/issues/new
.. _email: ilin@astron.nl

Owner

  • Login: ekaterinailin
  • Kind: user

JOSS Publication

AltaiPony - Flare science in Kepler, K2 and TESS light curves
Published
June 30, 2021
Volume 6, Issue 62, Page 2845
Authors
Ekaterina Ilin ORCID
Leibniz-Institute for Astrophysics Potsdam (AIP), An der Sternwarte 16, 14482 Potsdam, Germany, Institute for Physics and Astronomy, University of Potsdam, Karl-Liebknecht-Str. 24/25, 14476 Potsdam, Germany
Editor
Dan Foreman-Mackey ORCID
Tags
astronomy stellar activity Kepler TESS K2 stellar flares

GitHub Events

Total
  • Issues event: 3
  • Issue comment event: 3
  • Push event: 6
  • Pull request review event: 1
  • Pull request review comment event: 1
  • Pull request event: 5
  • Fork event: 2
Last Year
  • Issues event: 3
  • Issue comment event: 3
  • Push event: 6
  • Pull request review event: 1
  • Pull request review comment event: 1
  • Pull request event: 5
  • Fork event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 479
  • Total Committers: 6
  • Avg Commits per committer: 79.833
  • Development Distribution Score (DDS): 0.023
Past Year
  • Commits: 11
  • Committers: 2
  • Avg Commits per committer: 5.5
  • Development Distribution Score (DDS): 0.091
Top Committers
Name Email Commits
ekaterinailin e****n@a****e 468
Guadalupe Tovar Mendoza t****g@u****u 7
gully i****y@g****m 1
Geert Barentsen g****t@b****e 1
Keyu Xing x****u@c****m 1
A Danila a****a@c****l 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 79
  • Total pull requests: 13
  • Average time to close issues: 11 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 20
  • Total pull request authors: 6
  • Average comments per issue: 0.89
  • Average comments per pull request: 0.62
  • Merged pull requests: 11
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 15 days
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 0.75
  • Average comments per pull request: 0.33
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ekaterinailin (53)
  • AndreiD4N (3)
  • retifrav (3)
  • sam687 (2)
  • aaronmaas (2)
  • tcjansen (1)
  • sjschmidt (1)
  • ceb8 (1)
  • JZeldes (1)
  • dia96 (1)
  • keyuxing (1)
  • Davconcha (1)
  • Meistermagier (1)
  • Awshesh12 (1)
  • afeinstein20 (1)
Pull Request Authors
  • ekaterinailin (5)
  • AndreiD4N (4)
  • dfm (2)
  • barentsen (1)
  • lupitatovar (1)
  • keyuxing (1)
Top Labels
Issue Labels
enhancement (23) usability (14) testing (13) bug (6) docs (4) help wanted (4) structure and strategy (2) good first issue (1) sometime maybe (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 134 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 5
  • Total maintainers: 1
pypi.org: altaipony

Flare science in Kepler and TESS light curves

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 134 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 11.4%
Stargazers count: 12.9%
Average: 14.8%
Downloads: 18.2%
Dependent repos count: 21.6%
Maintainers (1)
Last synced: 6 months ago

Dependencies

docs/requirements.txt pypi
  • corner *
  • emcee *
  • lightkurve *
  • matplotlib *
  • numpydoc *
  • progressbar2 *
  • sphinx-automodapi *
requirements.txt pypi
  • astropy >=4.1
  • corner *
  • emcee *
  • gatspy *
  • k2sc ==1.0.1.4
  • lightkurve >=2
  • numpy >=1.15.1
  • pandas >=1.0,
  • progressbar2 >=3.51.4
  • pybind11 *
  • scipy >=1.5.0
  • seaborn *
setup.py pypi
  • corner *
  • emcee *
  • george >=0.3
  • k2sc ==1.0.1.4
  • lightkurve >=2
  • numpy >=1.15.1
  • pandas ==1.1.4,
  • progressbar2 >=3.51.4
  • pybind11 *
  • scipy >1.5
  • seaborn *
.github/workflows/python-package.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite