Skip to main content

generates rasters of near-real-time GEOS-5 FP near-surface meteorology

Project description

GEOS5FP Python Package

CI

The GEOS5FP Python package generates rasters of near-real-time GEOS-5 FP near-surface meteorology.

Gregory H. Halverson (they/them)
gregory.h.halverson@jpl.nasa.gov
NASA Jet Propulsion Laboratory 329G

Installation

This package is available on PyPi as a pip package called GEOS5FP.

pip install GEOS5FP

Usage

Import this package as GEOS5FP.

from GEOS5FP import GEOS5FPConnection
from datetime import datetime

Creating a Connection

# Create connection to GEOS-5 FP data
conn = GEOS5FPConnection()

Generating Raster Data

Generate georeferenced raster data for a specific time and optional target geometry:

from rasters import RasterGeometry

# Define target geometry (optional - if not provided, uses native GEOS-5 FP grid)
target_geometry = RasterGeometry.open("target_area.tif")

# Get air temperature raster for a specific time
time_utc = datetime(2024, 11, 15, 12, 0)
temperature_raster = conn.Ta_K(time_UTC=time_utc, geometry=target_geometry)

# Get soil moisture raster
soil_moisture_raster = conn.SM(time_UTC=time_utc, geometry=target_geometry)

# Get leaf area index raster
lai_raster = conn.LAI(time_UTC=time_utc, geometry=target_geometry)

# Save raster to file
temperature_raster.to_geotiff("temperature.tif")

Available raster methods include:

  • Ta_K() - Air temperature (Kelvin)
  • Ts_K() - Surface temperature (Kelvin)
  • SM() / SFMC() - Soil moisture
  • LAI() - Leaf area index
  • NDVI() - Normalized difference vegetation index
  • RH() - Relative humidity
  • And many more (see variables.csv for complete list)

Generating Table Data

Query point locations or time series to generate tabular data as pandas DataFrames:

Single Point Query

from shapely.geometry import Point

# Define point location (longitude, latitude)
point = Point(-118.25, 34.05)  # Los Angeles

# Get data for single point at specific time
time_utc = datetime(2024, 11, 15, 12, 0)
result = conn.Ta_K(time_UTC=time_utc, geometry=point)
print(result)  # Returns DataFrame with temperature value

Multiple Points Query

from shapely.geometry import MultiPoint

# Define multiple points
points = MultiPoint([
    (-118.25, 34.05),   # Los Angeles
    (-122.42, 37.77),   # San Francisco
    (-73.94, 40.73)     # New York
])

# Query multiple points at once
results = conn.Ta_K(time_UTC=time_utc, geometry=points)
print(results)  # Returns DataFrame with one row per point

Time Series Query

from datetime import timedelta

# Define time range
end_time = datetime(2024, 11, 15, 0, 0)
start_time = end_time - timedelta(days=7)  # 7 days of data

# Get time series for a point location
lat, lon = 34.05, -118.25
df = conn.variable(
    "Ta_K",
    time_range=(start_time, end_time),
    lat=lat,
    lon=lon
)
print(df)  # Returns DataFrame with time series

Multi-Variable Query

# Query multiple variables at once
variables = ["Ta_K", "SM", "LAI"]
df_multi = conn.variable(
    variable_name=variables,
    time_range=(start_time, end_time),
    lat=lat,
    lon=lon
)
print(df_multi)  # Returns DataFrame with columns for each variable

Vectorized Spatio-Temporal Query

import pandas as pd
import geopandas as gpd

# Load spatio-temporal data from CSV
data = pd.read_csv("locations.csv")  # Should have columns: time_UTC, lat, lon
data['time_UTC'] = pd.to_datetime(data['time_UTC'])

# Create geometries
gdf = gpd.GeoDataFrame(
    data,
    geometry=gpd.points_from_xy(data['lon'], data['lat'])
)

# Query all points and times at once (vectorized operation)
results = conn.variable(
    variable_name=["Ta_K", "SM", "LAI"],
    time_UTC=gdf['time_UTC'],
    geometry=gdf['geometry']
)
print(results)  # Returns DataFrame with results for all locations and times

Using Raw GEOS-5 FP Variables

You can also query variables directly by their GEOS-5 FP product and variable names:

# Query specific humidity from tavg1_2d_slv_Nx product
df = conn.variable(
    "QV2M",  # Raw GEOS-5 FP variable name
    time_range=(start_time, end_time),
    dataset="tavg1_2d_slv_Nx",
    lat=lat,
    lon=lon
)

See GEOS5FP/variables.csv for the complete list of available variables and their mappings.

Data Source & Citation

This package accesses GEOS-5 FP (Forward Processing) data produced by the Global Modeling and Assimilation Office (GMAO) at NASA Goddard Space Flight Center.

Data Access

GEOS-5 FP data is accessed through:

  • OPeNDAP Server: https://opendap.nccs.nasa.gov/dods/GEOS-5/fp/
  • HTTP Server: https://portal.nccs.nasa.gov/datashare/gmao/geos-fp/das

Data is provided by NASA's Center for Climate Simulation (NCCS).

Citation

When using GEOS-5 FP data in publications, please cite:

Data Product:

Global Modeling and Assimilation Office (GMAO) (2015), GEOS-5 FP: GEOS Forward 
Processing for Instrument Support, Greenbelt, MD, USA, Goddard Earth Sciences 
Data and Information Services Center (GES DISC). 
Accessed: [Date]

Acknowledgment:

GEOS-5 FP data used in this study were provided by the Global Modeling and 
Assimilation Office (GMAO) at NASA Goddard Space Flight Center through the 
NASA Center for Climate Simulation (NCCS).

For more information about GEOS-5 FP, visit: https://gmao.gsfc.nasa.gov/GEOS/

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

geos5fp-2.0.1.tar.gz (720.8 kB view details)

Uploaded Source

Built Distribution

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

geos5fp-2.0.1-py3-none-any.whl (49.4 kB view details)

Uploaded Python 3

File details

Details for the file geos5fp-2.0.1.tar.gz.

File metadata

  • Download URL: geos5fp-2.0.1.tar.gz
  • Upload date:
  • Size: 720.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for geos5fp-2.0.1.tar.gz
Algorithm Hash digest
SHA256 b387d3777255f319cb3d87c58f277778a8fabcfff264bba61ded7cbbe0d7338a
MD5 23e745cb2f53e1c2dc28672990f1c71b
BLAKE2b-256 1ed175b3f150774c45286ca4c2fee07376942c32d77e220ae0cfc6c3727bee13

See more details on using hashes here.

File details

Details for the file geos5fp-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: geos5fp-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 49.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for geos5fp-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e00bd903253e750c22e9b0ed98e58339d52ce89fe2d108ae4a73400b88806640
MD5 2825ca92d4cd435b72f1af77c9e5d7bc
BLAKE2b-256 d99fe9b9fa9ca59794c8b5878efe03bb5011593596d0484c400525cf3b2764c8

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