Rewrite the structure description in a short and accessible way for new users.

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

Rewrite the structure description in a short and accessible way for new users. #25

Closed ekaterinailin closed 6 years ago

ekaterinailin commented 6 years ago

What needs to be created or improved?

Can you provide an example?

top level modules - FlareLightCurve, wrapper places
core functions - flare finding, injection/recovery, analysis
helper modules - IO, MAST caller

What is the goal / expected behaviour?

Regardless of verb-y and descriptive module names the code structure can remain opaque to users or my future self. To prevent this, note your current idea that the code's structure represents.

ekaterinailin commented 6 years ago

See the README.