search

lightkurve / lightkurve

A friendly package for Kepler & TESS time series analysis in Python.
https://lightkurve.github.io/lightkurve/
MIT License
429 stars 171 forks source link

Quick start tutorial issues #695

Open rebekah9969 opened 4 years ago

rebekah9969 commented 4 years ago

There are several items which would be added to the Quickstart tutorial that would aid a first time user, these include the following,

  1. A better description of what Anaconda is and why lightkurve uses it. It would also be useful to explain that to run Anaconda you need to have the bash shell set up. The various "flavors" of Anaconda should also be explained. When installed the user should also check that it has been set up correctly by doing... Mac: export PATH="$HOME/anaconda3/bin:$PATH"

Linux: export PATH="/user/username/anaconda2/bin"

  1. Channels should be explained. lightkurve is one of these and its installment should be clarified.

  2. Provide a link to explain what a light curve is.

  3. Add links to the Kepler and TESS missions. Make clear what a cadence is and what a quarter/sector is in each data set.

  4. Explain that the tutorials use Jupiter notebook and how to install. Although the Jupiter notebook like is provided there is no instruction of this or even how to get Jupyter notebook. A link to the site https://jupyter.org and instructions on installation https://jupyter.org/install should be provided.

  5. search_targetpixelfile has no link - would be good to link this to a description.

  6. There is a link to the data archive. It might be good to also link to the MAST user website https://proper.stsci.edu/proper/authentication/auth

  7. When running pixelfile = search_targetpixelfile(8462852, quarter=16).download(quality_bitmask='hardest'); there is a warning Warning: 8462852 may refer to a different Kepler or TESS target. Please add the prefix 'KIC' or 'TIC' to disambiguate. Warning: 25% (1042/4203) of the cadences will be ignored due to the quality mask (quality_bitmask=2096639). This is causes because the hardest bitmask is applied. Bitmasks should be explained and the following link added https://docs.lightkurve.org/api/lightkurve.utils.KeplerQualityFlags.html#lightkurve.utils.KeplerQualityFlags.DEFAULT_BITMASK.

  8. The Kepler and TESS concept of cadence and quarters should also be clarified.

  9. Add a print(lc) command under lc = pixelfile.to_lightcurve(aperture_mask='all'); to illustrate what has been generated.

  10. Print light curve data in a table so it is readable.

github-actions[bot] commented 4 years ago

Hi there! 👋 Thank you for opening your first Lightkurve issue! 🙏 One of our maintainers will get back to you as soon as possible. 👩‍🚀 We love that you are using Lightkurve and appreciate your feedback. 👍

rebekah9969 commented 4 years ago

I am currently updating this tutorial to fix issues above.

barentsen commented 4 years ago

@rebekah9969 Thank you so much for looking through the tutorials, this is awesome, needed, and much-appreciated! :+1::+1::+1:

The tutorials are indeed in need of revision because they haven't always been kept up to date with changes in the Lightkurve API. In addition, there is a huge opportunity to make the tutorials more accessible and have them cover more use cases.

Just a quick thought: I'd vote in favor of keeping the quickstart tutorial very short, and e.g. add the detailed information on Anaconda in a more comprehensive "installation guide" with a few helpful links in the quick start to it.

I'm on leave right now but would be happy to discuss more over the phone next week! :phone:

rebekah9969 commented 4 years ago

Hello all

I have done some work on the Quickstart tutorial and will show Tom today. I agree however that we should not add too much info and have mainly just added links and a couple of sentence. I think an intro to TESS data is needed however and will be working on that in the coming days.

Thanks

On Wed, Feb 26, 2020 at 10:06 PM Geert Barentsen notifications@github.com wrote:

@rebekah9969 https://github.com/rebekah9969 Thank you so much for looking through the tutorials, this is awesome, needed, and much-appreciated! 👍👍👍

The tutorials are indeed in need of revision because they haven't always been kept up to date with changes in the Lightkurve API. In addition, there is a huge opportunity to make the tutorials more accessible and have them cover more use cases.

Just a quick thought: I'd vote in favor of keeping the quickstart tutorial very short, and e.g. add the detailed information on Anaconda in a more comprehensive "installation guide" with a few helpful links in the quick start to it.

I'm on leave right now but would be happy to discuss more over the phone next week! ☎️

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/KeplerGO/lightkurve/issues/695?email_source=notifications&email_token=AEFRHG5PJLKANV53KUG7NQTRE4U33A5CNFSM4K3Q6JJKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENCXUCQ#issuecomment-591755786, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEFRHGZ6ZUDUAQ63Y3LPJPTRE4U33ANCNFSM4K3Q6JJA .