diff --git a/README.rst b/README.rst index bc87493..a744772 100644 --- a/README.rst +++ b/README.rst @@ -2,18 +2,14 @@ lksearch ######## -.. .. - - +.. **Helpful package to search for TESS/Kepler/K2 data** **lksearch** is a community developed, open source Python package that offers a user-friendly approach to searching the `Barbara A. Mikulski Archive for Space Telescopes (MAST) `_ web portal for scientific data and mission products from **NASA's TESS, K2, and Kepler missions**. This package aims to lower the barrier for students, astronomers, and citizen scientists interested in analyzing time-series data from these NASA missions. It does this by providing a set of streamlined classes with simplified inputs and outputs that wraps `Astroquery's `_ `MAST.Observations `_ class with user-friendly post-processing of observation tables and convenient bundled download methods. -.. .. - - +.. Documentation ============= @@ -23,9 +19,7 @@ Check out the `tutorial notebook ` Read the `documentation`_ .. _`documentation`: https://tylerapritchard.github.io/TSSC/ -.. .. - - +.. Quickstart and Installation =========================== @@ -78,13 +72,9 @@ Usage res = TESSSearch("TOI 2257").tesscut res.download() -.. .. - - - -.. .. +.. - +.. Contributing ============ @@ -92,26 +82,18 @@ Contributing We welcome community contributions! Guidelines TBD -.. .. +.. - - -.. .. - - +.. Citing ====== If you find *lksearch* useful in your research, please cite it and give us a GitHub star! -Please read the citation instructions here `citation instructions `_ . -.. .. - - - -.. .. +Citation Instructions TBD +.. - +.. Contact ======= @@ -123,6 +105,5 @@ The best way to contact us is to `open an issue`_ or to e-mail tesshelp@bigbang. .. _`open an issue`: https://github.com/lightkurve/lksearch/issues/new Please include a self-contained example that fully demonstrates your problem or question. -.. .. - +..