Merge pull request #23 from lightkurve/querycatalogs

Add catalog queries to `lksearch`
lightkurve · Dec 6, 2024 · 868fc11 · 868fc11
2 parents ada51c5 + ec6cfb1
commit 868fc11
Show file tree

Hide file tree

Showing 23 changed files with 4,775 additions and 570 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install poetry
-          poetry install --with dev
+          poetry install --with dev,cloud
       - name: Sphinx build
         run: |
           poetry run sphinx-build docs _build

diff --git a/README.rst b/README.rst
@@ -112,6 +112,16 @@ Please include a self-contained example that fully demonstrates your problem or
 
 Changelog:
 ==========
+v1.1.0
+  - Added ability to query catalogs using the catalogsearch module. This includes:
+    - querying vizier for a region for sources using query_region
+    - querying vizier for a catlog for rows corresponding to ids using query_id
+    - querying simbad for alternative names for a given name using query_names
+    - matching alternative names for sources to catalog stings using match_names_catalogs
+  - Added documentation for catalogsearch in docs/tutorials/catalog-searches.ipynb
+  - Broke previous tutorial doucmentation into multiple files:
+    - mission-search focussed data-searches.ipynb
+    - cloud-searches and configuration options in cloud-data-searches.ipynb
 v1.0.1
   - Now resolving target search strings with MastClass [#27]
 v1.0

diff --git a/docs/apidoc.rst b/docs/apidoc.rst
@@ -15,5 +15,8 @@ API
 .. autoclass:: lksearch.TESSSearch
    :members:
 
+.. automodule:: lksearch.catalogsearch
+   :members:
+
 .. automodule:: lksearch.config
    :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -15,7 +15,7 @@ lksearch
    :hidden:
 
    Quickstart
-   tutorials/Example_searches
+   tutorials/index
    apidoc
    GetInvolved
    HowtoCite