Skip to content

Commit

Permalink
fixed README comment header blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
tylerapritchard committed May 2, 2024
1 parent 7c90a45 commit 4ba8df2
Showing 1 changed file with 11 additions and 30 deletions.
41 changes: 11 additions & 30 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,14 @@
lksearch
########

.. ..
<!-- intro content start -->
.. <!-- intro content start -->
**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) <https://mast.stsci.edu/portal/Mashup/Clients/Mast/Portal.html>`_ 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 <https://astroquery.readthedocs.io/en/latest/#>`_ `MAST.Observations <https://astroquery.readthedocs.io/en/latest/mast/mast_obsquery.html>`_ class with user-friendly post-processing of observation tables and convenient bundled download methods.
.. ..
<!-- intro content end -->
.. <!-- intro content end -->
Documentation
=============
Expand All @@ -23,9 +19,7 @@ Check out the `tutorial notebook <tutorials/Example_searches.ipynb>`
Read the `documentation`_
.. _`documentation`: https://tylerapritchard.github.io/TSSC/

.. ..
<!-- quickstart content start -->
.. <!-- quickstart content start -->
Quickstart and Installation
===========================
Expand Down Expand Up @@ -78,40 +72,28 @@ Usage
res = TESSSearch("TOI 2257").tesscut
res.download()
.. ..
<!-- quickstart content end -->

.. ..
.. <!-- quickstart content end -->
<!-- Contributing content start -->
.. <!-- Contributing content start -->
Contributing
============

We welcome community contributions!
Guidelines TBD

.. ..
.. <!-- Contributing content end -->
<!-- Contributing content end -->

.. ..
<!-- Citing content start -->
.. <!-- Citing content start -->
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 <docs/How-to-Cite>`_ .
.. ..
<!-- Citing content end -->

.. ..
Citation Instructions TBD
.. <!-- Citing content end -->
<!-- Contact content start -->
.. <!-- Contact content start -->
Contact
=======
Expand All @@ -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.
.. ..

<!-- Contact content end -->
.. <!-- Contact content end -->

0 comments on commit 4ba8df2

Please sign in to comment.