aninramesh / nasa-pace-data-reader

This repository contains a Python package for reading L1C files from NASA PACE instruments (HARP2, SPEXone, OCI). Development includes planned readers for L2 aerosol and surface products.

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.

Dependencies

---

• Python v3.10 and above

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.

Installing from Github source code

1. cd to git directory
2. Enter the command pip install -e ./

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, plot    # 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':
        try:
            print('{:<24}:{}'.format(key, l1c_dict[key].shape))
        except:
            print('Key error')

# 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.5.0

• Apply this version for data from OBDAAC that is after April 11th, 2024.
• Updated OCI L1C variable names to ensure consistency with all other instruments.
• Resolved the projection issue with SPEXOne data.
• Option to read HARP2 (GRASP-Anin) L2 product has been added. See Examples/L2-HARP2-GRASP-example.py to understand how it can be used.

v0.0.4.10

• Fixed the projection issue at -180 to 180 longitude transition line

v0.0.4.8

• Added option to plot highRes blue marble

v0.0.4.7

• The bug concerning the projectRGB() function has been resolved. Users can now input float values for normFactor and scale, whereas previously only int values were permitted. (Issue: #2)

v0.0.4.6

• Added rotation_angle to the variables

v0.0.4.4

• Resolved the projection problem with the composite image for granules near the dateline by including the flag returnTransitionFlag=True in the projectRGB() function.

v0.0.4.3

• Included the capability to read the HARP2 L1C file with sensor counts.

v0.0.4.2

• Resolved the issue related to averaging negative and positive longitudes.

v0.0.3.26

• Enhanced projection options for faster generation of interpolated RGB and extent.
• Addressed and resolved bugs associated with reading OCI and HARP2 files.

v0.0.3.23

• Multiple projection in the RGB movie

v0.0.3.22

• Added a script to plot the RGB movie

v0.0.3.20

• Added Examples/auto-image-gen-harp2.py to automate the L1C image plotting

v0.0.3.19

• Adjustments made to account for the accurate variable name in the L1C file.
• Implemented the option to plot L1B (HARP2).

v0.0.3.18

• Masked the black pixels in the projected RGB

v0.0.3.17

• Added the option to load OCI L1C file and plot the spectrum

v0.0.3.16

• The bug related to plotting multiple band data has been resolved.

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

nasa-pace-data-reader's Issues

Bug in the projectedRGB()

When utilizing the proj='Orthographic' projection, the 'scale' argument cannot be used.

plt_.projectedRGB(proj='Orthographic', normFactor =300, scale=0.5)

---------------------------------------------------------------------------
{
	"name": "TypeError",
	"message": "'float' object is not subscriptable",
	"stack": "---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
Cell In[5], line 1
----> 1 plt_.projectedRGB(proj='Orthographic', normFactor =300, scale=0.5)

File ~/git/nasa-pace-data-reader/Examples/nasa_pace_data_reader/plot.py:679, in Plot.projectedRGB(self, rgb, scale, ax, fig, var, viewAngleIdx, normFactor, proj, saveFig, noShow, rivers, lakes, rgb_dolp, figsize, savePath, dpi, setTitle, returnRGB, lon_0, lat_0, black_background, proj_size, returnTransitionFlag, **kwargs)
    677 # if RGB does not exist, run the plotRGB method
    678 if rgb is None:
--> 679     self.plotRGB(var=var, viewAngleIdx=viewAngleIdx, scale=scale, normFactor=normFactor, returnRGB=True, plot=False, rgb_dolp=rgb_dolp,
    680                        **kwargs)
    682 # Check the shape of the RGB data
    683 assert self.rgb.shape[2] == 3, 'Invalid RGB data'

File ~/git/nasa-pace-data-reader/Examples/nasa_pace_data_reader/plot.py:462, in Plot.plotRGB(self, var, viewAngleIdx, scale, normFactor, returnRGB, plot, rgb_dolp, saveFig, **kwargs)
    460     else:
    461         for i in range(3):
--> 462             rgb[:, :, i] = rgb[:, :, i]/normFactor*scale[i]
    463 # copy the rgb to a new variable
    464 
    465 # Plot the RGB image
    466 if plot:

TypeError: 'float' object is not subscriptable"
}