Skip to main content

A package for reading NASA PACE data files.

Project description

NASA-PACE-Data-Reader

This repository hosts a Python package designed to read L1C files from NASA PACE instruments, including HARP2, SPEXone, and OCI. Future development plans include the addition of readers for L2 aerosol and surface products.

Installing the library from PyPi

To install the python library "nasa-pace-data-reader", follow these steps:

  1. Open the command prompt or terminal.
  2. Enter the command pip install nasa-pace-data-reader.
  3. It is recommended to run this command in a separate pip or conda environment to prevent dependency conflicts.

Building and Uploading the Package (For package maintainers):

To build and upload the package, you can either run the sh Install.sh script (ensure to specify the correct version).


Example Usage:

See the example python notebook Examples/L1C-example.ipynb

Here is a simple example of how to use the package:

from nasa_pace_data_reader import L1    # Reader library
from nasa_pace_data_reader import plot  # Plotting library

# Location of the file
fileName = '/Users/aputhukkudy/Downloads/PACE_HARP2.20220321T101844.L1C.5.2KM.V03.SIM2.1_.nc'

# Read the file
l1c = L1.L1C()
l1c_dict = l1c.read(fileName)

# Print the keys and the shape of the data
l1c_dict.keys()
for key in l1c_dict.keys():
    if key != '_units':
        print('{:<24}:{}'.format(key, l1c_dict[key].shape))

# Define the pixel
pixel = [250,300]

# Load the plot class
plt_ = plot.Plot(l1c_dict)

# set which band to plot
band = 'Blue'
plt_.setBand(band)

# Read the 'i' for a pixel
i = l1c_dict['i'][pixel[0], pixel[1], plt_.bandAngles]
print('i:', i)
print('viewing angles:', l1c_dict['view_angles'][plt_.bandAngles])

# Set the dpi
plt_.setDPI(256)

# set which band to plot
band = 'NIR'
plt_.setBand(band)

# Plot the pixel
plt_.plotPixel(pixel[0], pixel[1])

# define the wavelengths and variables to plot
plt_.setInstrument()

# plot all vars and bands
plt_.plotPixelVars(pixel[0], pixel[1])

# plot only specific bands and vars
plt_.vars2plot = ['i', 'q', 'u']    # Order in the list is the order of plotting
plt_.bands2plot = ['NIR', 'blue']   # Order in the list is the order of plotting

# plot 
plt_.plotPixelVars(pixel[0], pixel[1], bands= plt_.bands2plot, alpha=0.5, linewidth=0.5) # you can pass any other arguments to the plot function

# plot RGB image
# Load the plot class
plt_ = plot.Plot(l1c_dict)

# Plot RGB
plt_.plotRGB(scale=1, returnRGB=True)

# plot RGB in default plate carree projection
plt_.projectedRGB()

# plot RGB in Orthographic projection
plt_.projectedRGB(proj='Orthographic')

# plot one variable in a specific projection at closest viewing angle to nadir
band = 'Red'
plt_.setBand(band)
plt_.projectVar('i',  dpi=300)

# Plotting reflectance at closest viewing angle to -35 degrees
plt_.reflectance = True
plt_.projectVar('u',  viewAngle=-35)

Change Log:


v0.0.3.15

  • Option to project one variable to the map
  • the viewing angle can be specified easily

v0.0.3.14

  • Added the ability to plot projected RGB using cartopy.
  • Removed Basemap library from the dependencies

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nasa_pace_data_reader-0.0.3.15.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nasa_pace_data_reader-0.0.3.15-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file nasa_pace_data_reader-0.0.3.15.tar.gz.

File metadata

  • Download URL: nasa_pace_data_reader-0.0.3.15.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.13

File hashes

Hashes for nasa_pace_data_reader-0.0.3.15.tar.gz
Algorithm Hash digest
SHA256 9c9576ec3bb0e3665e6e88932654a15d28d4c8aa97b00c1f888c09c34f374804
MD5 079741fa9c4eb204d97cae1357b6a885
BLAKE2b-256 5a171b63cf808c72fe655bf51a3257a5887e831cdb262fa07e5d41016e752557

See more details on using hashes here.

File details

Details for the file nasa_pace_data_reader-0.0.3.15-py3-none-any.whl.

File metadata

File hashes

Hashes for nasa_pace_data_reader-0.0.3.15-py3-none-any.whl
Algorithm Hash digest
SHA256 a5ae4aaf33e2ba6cd6c7750f086e1b6a207278134b4b1b17dd3e6554f7208b2b
MD5 e50a9e9d73eda71dc3c52ba0c2f473a3
BLAKE2b-256 c351c014ad889b8d9961a00569e88e7b1ea132aa1ecaf34d9087665996cf5889

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page