nasa-pds / search-api-notebook

Jupyter notebooks for demonstrating and utilizing the Planetary Data System (PDS) Search API

Planetary Data System API Notebook

This repository contains example JupyterLab notebooks for the application programmer's interface (API) of the Planetary Data System. You can incorporate these into your existing JupiyterLab notebooks for the plotting and exhibition of planetary and other scientific data, and use them as springboards for new notebooks. You can also run these notebooks directly on any Python-capable computer with a web browser.

🖥 Prerequisites

To run these notebooks locally, you'll need Python 3.7 or later as well as a web browser.

🏃‍♀️ Getting Started

Run the following commands from a terminal and your default web browser should launch:

$ # Create a virtual Python environment to isolate Jupyter and PDS dependencies
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install --upgrade --quiet pip
$ # Install the dependencies
$ pip install --requirement requirements.txt
$ # Start it up
$ jupyter-lab

At this point you'll have a locally running JupyterLab server and your browser opened to it. (If not, point your browser to http://localhost:8888/lab).

From here, you can try out the PDS API notebooks in the /notebooks/ folder in the file tree on the left side:

• ovirs contains demonstration notebooks for the OSIRIS-REx Visible and InfraRed Spectrometer, OVIRS. Within this folder are two sub-folders with the actual demonstration notebooks:
  • part1 has the notebook explore-a-collection.ipynb that shows how to get a get and explore a data collection with the API.
  • part2 has a notebook find-data-standalone.ipynb that extracts a specific data collection subset. A demo video of this notebook is available.
• galileo magnetometer exhibits using PDS data in WWT via the PDS API. Run the following commands to configure your notebook to run pyWWT.

$ jupyter labextension install --no-build @jupyter-widgets/jupyterlab-manager
$ jupyter labextension install --no-build @wwtelescope/jupyterlab
$ jupyter lab build
$ # To start up 
$ jupyter-lab

Note that to interact with the pyWWT window, you must open a new tab in the jupyter notebook and select the AAS WorldWide Telescope icon. For further instructions and troubleshooting, see the pyWWT installation page.

👥 Contributing

Within the NASA Planetary Data System, we value the health of our community as much as the code. Towards that end, we ask that you read and practice what's described in these documents:

• Our contributor's guide delineates the kinds of contributions we accept.
• Our code of conduct outlines the standards of behavior we practice and expect by everyone who participates with our software.

📃 License

The project is licensed under the Apache version 2 license.

search-api-notebook's Issues

As a user, I want to get a sample of 1000 of a variety of observational products

💪 Motivation

...so to answer a @jshughes request

📖 Additional Details

A notebook has been started in branch 1000_sample

⚖️ Acceptance Criteria

Given
When I perform
Then I expect

⚙️ Engineering Details

Test performing a basic search for Galileo magnetometer data using registry-api in a python notebook

💡 Description

Data layer separation for pyWWT visualization

Add a feature to pyWWT so that each lid is a separate data layer in the widget.

Time series plot for pyWWT data visualization

Plotting magnetometer data against time for a specified time range.

Update OREX Notebook to use PDS4 Tools to read and visualize the data

Checked for duplicates

Yes - I've already checked

🧑‍🔬 User Persona(s)

Data Engineer/ Data User

💪 Motivation

...so that I can [why do you want to do this?]

📖 Additional Details

Instead of using the pandas library to grab the PDS4 data and import it into a data frame, we would like to implement the PDS4_tools library instead. This would simplify the code and provide additional examples for other users in using the PDS4 tools with the data base.

Acceptance Criteria

Given a data product
When I perform an import of the product
Then I expect a working dataframe from the pds4_tools

⚙️ Engineering Details

will be using pds4_read() instead of pandas.read_fwf()

Notebooks no longer work with V1.0 release

🐛 Describe the bug

• Data in the registry is incorrect
• Queries go against pds-gamma instead of ops registry

Geographic data extraction and visualization

💡 Description

Use MESSENGER dataset collections

Would need to look at a way to access the data from S3 instead of HTTP access.

Make a notebook to visualize thumbnails of PDS4 IMG files (extracted thanks to the API)

💡 Description

Identify a good collection for images data, from the initial request:

https://pds.nasa.gov/api/search/1/products?q=((pds:Science_Facets.pds:wavelength_range eq "Visible") and not (ops:Harvest_Info.ops:node_name eq "PDS_SBN"))&start=0&limit=500

Use either matlplotlib or pds4_tools for the visualization.

As a user, I want to visualize Cassini Magnetometer data with latest SPICE Kernels using pyWWT

Checked for duplicates

Yes - I've already checked

🧑‍🔬 User Persona(s)

Cassini Data User

💪 Motivation

...so that I can do an awesome search an visualization in a Jupyter notebook

📖 Additional Details

No response

Acceptance Criteria

Given
When I perform
Then I expect

⚙️ Engineering Details

No response

Test extracting lat/long bounding box info from python component with STAC API

💡 Description

Connect leaflet-cartocosmos component to the TBD data bounding box attributes in the registry-api

💡 Description

As a data user, I want to utilize pyWWT to visualize Jupiter's magnetopause

Checked for duplicates

Yes - I've already checked

🧑‍🔬 User Persona(s)

Data Engineer/ Data User

💪 Motivation

...so that I can better understand Galileo's magnetometer data

📖 Additional Details

Import a model of Jupiter's magnetopause into pyWWT as an accurate representation of the magnetopause geometry.

Acceptance Criteria

Given a 3D model of Jupiter's magnetopause
When I perform magnetometer reading visualization
Then I expect the 3D model to be displayed in the widget along side the magnetometer readings.

⚙️ Engineering Details

Will require insight from the PPI team for the model creation. In the meantime a test case will be developed to demonstrate pyWWT's ability to visualize 3D models.

Prototype integration of pyWWT and PDS Search API in Jupyter

💡 Description

To Be completed with sub-ticket for the tasks, e.g.:

• #13
• #21
• #20

Develop notebook for Apollo Passive Seismic Experiment data

💡 Description

From Francesco C.

• I think that seismic data would be a good test case for cloud data operation and analysis. Specifically, I’m thinking the Apollo Passive Seismic Experiment data, which is currently hosted in PDS4 format at the Geosciences node.
• Slots in well with the upcoming Farside Seismic Suite mission as well as Artemis.
• I have algorithms already ready to go for data visualization, data extraction (via catalogs), analysis using signal processing, and machine learning signal detection (to test CPU vs GPU computing). Let me know if you want details and I can send you documents or some slides.

As a user, I want to retrieve and view IR/UV/Visual wavelength images

Checked for duplicates

No - I haven't checked

🧑‍🔬 User Persona(s)

Data Engineer, Data User

💪 Motivation

...so that I can demonstrate how to use the search API and analyze images provided a specified target, time range, wavelength,etc.

📖 Additional Details

Still need to find applicable data sets for this use case.

Acceptance Criteria

Given a target and wavelength specification
When I perform search in PDS
Then I expect to view data products related to my search specifications

⚙️ Engineering Details

No response

Use GDAL Digital Elevation Model visualization features

💡 Description

See Trent's input:
DEMs allow for lots of visualization opportunities. These PDS4 data should open using GDAL as shown here.
https://gis.stackexchange.com/questions/66367/display-a-georeferenced-dem-surface-in-3d-matplotlib (edited)