.. image:: https://github.com/lightkurve/lksearch/actions/workflows/python-app.yml/badge.svg :target: https://github.com/lightkurve/lksearch/actions/workflows/python-app.yml :alt: Test status
.. image:: https://badge.fury.io/py/lksearch.svg :target: https://badge.fury.io/py/lksearch :alt: PyPI version
.. image:: https://img.shields.io/badge/documentation-live-blue.svg :target: https://lightkurve.github.io/lksearch/ :alt: Documentation
######## 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) <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.
..
..
The easiest way to install lksearch and all of its dependencies is to use the pip command,
which is a standard part of all Python distributions. (upon release)
To install lksearch, run the following command in a terminal window:
.. code-block:: console
$ python -m pip install lksearch --upgrade
The --upgrade flag is optional, but recommended if you already
have lksearch installed and want to upgrade to the latest version.
Depending on the specific Python environment, you may need to replace python
with the correct Python interpreter, e.g., python3.
This package is a stand-alone implementation of the lightkurve search functionalty. While this package shares many common features to the lightkurve.search module, it has many major changes, as described below.
.. code-block:: python
from lksearch import MASTSearch, TESSSearch, KeplerSearch, K2Search
res = search.KeplerSearch("KIC 11904151", exptime="long").cubedata
res = TESSSearch("TOI 2257").tesscut res.download()
..
..
lksearch is an open-source, community driven package.
We welcome users to contribute and develop new features for lksearch.
For further information, please see the Lightkurve Community guidelines <https://docs.lightkurve.org/development/contributing.html>_.
..
..
If you find lksearch useful in your research, please cite it and give us a GitHub star!
If you use Lightkurve for work or research presented in a publication, we request the following acknowledgment or citation:
This research made use of Lightkurve, a Python package for Kepler and TESS data analysis (Lightkurve Collaboration, 2018).
See full citation instuctions, including dependencies, in the Lightkurve documentation <https://docs.lightkurve.org/about/citing.html>_.
..
..
lksearch is an open source community project created by the TESS Science Support Center.
The best way to contact us is to open an issue or to e-mail tesshelp@bigbang.gsfc.nasa.gov.
.. _TESS Science Support Center: https://heasarc.gsfc.nasa.gov/docs/tess/
.. _open an issue: https://github.com/lightkurve/lksearch/issues/new
Please include a self-contained example that fully demonstrates your problem or question.
..
..
..