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.12 or later as well as a web browser. Latest tests have been done with python3.12, but the notebooks should work with any version of python3.7 or later.

🏃‍♀️ Getting Started

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

Clone the current repository:

    git clone https://github.com/NASA-PDS/search-api-notebook.git
    cd search-api-notebook

Create a virtual environment:

$ python3.12 -m venv venv
$ source venv/bin/activate
$ pip install --upgrade --quiet pip

Option A — Install everything (all notebooks, all dependencies):

$ pip install --requirement requirements.txt

Option B — Install only what you need (faster, fewer packages):

Each discipline has its own requirements file. Install only the one matching the notebooks you want to run:

Directory	Requirements file	Key packages
notebooks/discipline/geo/	requirements-geo.txt	astropy, pds.peppi, pds4-tools, pdr
notebooks/discipline/img/	requirements-img.txt	geopandas, leafmap, pds.peppi
notebooks/discipline/ppi/	requirements-ppi.txt	astropy, pywwt, spiceypy, pds.peppi
notebooks/discipline/sbn/	requirements-sbn.txt	pds.peppi, pds.api_client, pdr
notebooks/generic/peppi-advanced/	requirements-peppi-advanced.txt	pds.peppi, pandas, matplotlib
notebooks/generic/simple/	requirements-simple.txt	pds.peppi, pdr, pandas
notebooks/generic/training_20260305/	requirements-training.txt	pds.peppi, pandas, requests

$ pip install --requirement requirements-peppi-advanced.txt   # example

Each notebook directory also has a README.md describing its notebooks and the exact install command.

Then install JupyterLab (not included in the per-discipline files):

$ pip install jupyterlab

And start JupyterLab where your code will run:

$ 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.

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.