API Cookbook

This Project Pythia Cookbook covers the basics of retrieving and visualizing data using APIs with Python.

Motivation¶

There are many ways to gather data. Science and research entities like NASA are constantly producing and collecting data. As a result, attempting to collect and display live data can be difficult since new data is always being added or modified.

An API is a method to query a data source over the internet to retrieve data from a remote source. APIs are useful tools for working with live and constantly updating data sources. However, the terminology and methods for retrieving and manipulating the data in Python can make APIs confusing.

This cookbook focuses on accessing and visualizing data from various geoscience related APIs. Over the course of the cookbook, we will show step-by-step tutorials on retrieving data from some public APIs, as well as creating informational and visually appealing graphics to communicate the data to a general audience.

Authors¶

Cora Schneck, Ana Krelling, Adam Deitsch, Hannah Zafar

Contributors¶

Structure¶

This cookbook will be broken up into two main sections: “Foundations” to cover the basics of working with and understanding APIs and “Example Workflows” for complete working examples.

API Foundations¶

API Foundations will cover the terminology of APIs and how to make use of the data retrieved from API in Python.

Example Workflows¶

Example Workflows will cover complete example of working with various APIs. This includes how to retrieve and understand data returned from different sources and manipulate the data to produce useful and appealing plots.

• JPL Center for Near-Earth Orbit Studies (CNEOS) API: Visualize the location and total impact energy of fireballs and bolides on a world map using the CNEOS Fireball API.
• Earthdata API: Access and visualize sea surface height and sea surface salinity data using the National Aeronautics and Space Administration’s earthaccess Python package.
• Air Quality System (AQS) API: Visualize and compare air quality and atmospheric chemistry concentrations over geographic areas by leveraging the Environmental Protection Agency’s pyaqsapi Python package.
• Whiteface Mountain Cloud Water Request: Request access to recent and historical cloud water chemistry data from the Lance Research Laboratory at the Atmospheric Sciences Research Center.

Running the Notebooks¶

You can either run the notebook using Binder or on your local machine.

Running on Binder¶

The simplest way to interact with a Jupyter Notebook is through Binder, which enables the execution of a Jupyter Book in the cloud. The details of how this works are not important for now. All you need to know is how to launch a Pythia Cookbooks chapter via Binder. Simply navigate your mouse to the top right corner of the book chapter you are viewing and click on the rocket ship icon, (see figure below), and be sure to select “launch Binder”. After a moment you should be presented with a notebook that you can interact with. I.e. you’ll be able to execute and even change the example programs. You’ll see that the code cells have no output at first, until you execute them by pressing Shift+Enter. Complete details on how to interact with a live Jupyter notebook are described in Getting Started with Jupyter.

Running on Your Own Machine¶

If you are interested in running this material locally on your computer, you will need to follow this workflow:

1. Clone the https://github.com/ProjectPythia/api-cookbook repository:

    git clone https://github.com/ProjectPythia/api-cookbook.git

2. Move into the api-cookbook directory

   cd api-cookbook

3. Create and activate your conda environment from the environment.yml file

   conda env create -f environment.yml
   conda activate cookbook-example

4. Move into the notebooks directory and start up Jupyterlab

   cd notebooks/
   jupyter lab