ekaterinailin / AltaiPony

Find flares in Kepler and TESS light curves. Notebooks for quickstart inside.
https://altaipony.readthedocs.io
MIT License
26 stars 10 forks source link

Write a quickstart guide. #11

Closed ekaterinailin closed 6 years ago

ekaterinailin commented 6 years ago

What needs to be created or improved?

Write a quickstart guide that runs a limited number of use cases for AltaiPony.

Can you provide an example?

import altaipony
lc = get_k2sc_lc(some_id)
lc = lc.k2sc_detrend()
flares = find_flares(lc)
plot(flares)

What is the goal / expected behaviour?

Instructions will help make the structure of the code more transparent for users and will expose counter-intuitive implementations such as unclear object (e.g. methods) names.

ekaterinailin commented 6 years ago

See this notebook.