Net Radiation and Daylight Upscaling Remote Sensing in Python
This Python package implements the net radiation and daylight upscaling methods described in Verma et al 2016.
Gregory H. Halverson (they/them)
gregory.h.halverson@jpl.nasa.gov
Lead developer
NASA Jet Propulsion Laboratory 329G
Installation
This package is distributed using the pip package manager as verma-net-radiation with dashes.
pip install verma-net-radiation
Usage
Import this package as verma_net_radiation with underscores.
This module provides functions to calculate instantaneous net radiation and its components, integrate daylight net radiation, and process radiation data from a DataFrame. Below is a detailed explanation of each function and how to use them.
verma_net_radiation
Description:
Calculates instantaneous net radiation and its components based on input parameters. Optionally upscales to daylight average net radiation if upscale_to_daylight=True.
Parameters:
ST_C(Union[Raster, np.ndarray, float]): Surface temperature in Celsius.emissivity(Union[Raster, np.ndarray, float]): Surface emissivity (unitless, constrained between 0 and 1).albedo(Union[Raster, np.ndarray, float]): Surface albedo (unitless, constrained between 0 and 1).SWin_Wm2(Union[Raster, np.ndarray, float], optional): Incoming shortwave radiation (W/m²). If not provided, will be retrieved from GEOS-5 FP if geometry and time_UTC are given.Ta_C(Union[Raster, np.ndarray, float], optional): Air temperature in Celsius. If not provided, will be retrieved from GEOS-5 FP if geometry and time_UTC are given.RH(Union[Raster, np.ndarray, float], optional): Relative humidity (fractional, e.g., 0.5 for 50%). If not provided, will be retrieved from GEOS-5 FP if geometry and time_UTC are given.geometry(RasterGeometry, optional): Spatial geometry for GEOS-5 FP retrievals.time_UTC(datetime, optional): UTC time for GEOS-5 FP retrievals.GEOS5FP_connection(GEOS5FP, optional): Existing GEOS5FP connection to use for data retrievals.resampling(str, optional): Resampling method for GEOS-5 FP data retrievals.cloud_mask(Union[Raster, np.ndarray, float], optional): Boolean mask indicating cloudy areas (True for cloudy).upscale_to_daylight(bool, optional): If True, returns daylight average net radiation as well.
Returns: A dictionary containing:
"SWout_Wm2": Outgoing shortwave radiation (W/m²)."LWin_Wm2": Incoming longwave radiation (W/m²)."LWout_Wm2": Outgoing longwave radiation (W/m²)."Rn_Wm2": Instantaneous net radiation (W/m²)."Rn_daylight_Wm2": Daylight average net radiation (W/m², only ifupscale_to_daylight=True).
Example:
results = verma_net_radiation(
ST_C=surface_temp_array,
emissivity=emissivity_array,
albedo=albedo_array,
SWin_Wm2=SWin_array,
Ta_C=air_temp_array,
RH=relative_humidity_array,
cloud_mask=cloud_mask_array,
upscale_to_daylight=True
)
daylight_Rn_integration_verma
Description:
Integrates instantaneous net radiation (Rn) to daylight average values using solar geometry parameters. Supports Raster, numpy array, or float inputs. If sunrise time or daylight hours are not provided, they are calculated from day of year and latitude.
Parameters:
Rn_Wm2(Union[Raster, np.ndarray, float]): Instantaneous net radiation (W/m²).hour_of_day(Union[Raster, np.ndarray, float]): Hour of the day (0-24) when Rn is measured.day_of_year(Union[Raster, np.ndarray, float], optional): Day of the year (1-365).lat(Union[Raster, np.ndarray, float], optional): Latitude in degrees.sunrise_hour(Union[Raster, np.ndarray, float], optional): Hour of sunrise (local time).daylight_hours(Union[Raster, np.ndarray, float], optional): Total daylight hours.
Returns:
Union[Raster, np.ndarray, float]: Daylight average net radiation (W/m²).
Notes:
- To obtain total daylight energy (J/m²), multiply the result by
(daylight_hours * 3600). - If
sunrise_hourordaylight_hoursare not provided, they are computed fromday_of_yearandlatusing solar geometry.
Example:
Rn_daylight = daylight_Rn_integration_verma(
Rn_Wm2=Rn_array,
hour_of_day=hour_of_day_array,
day_of_year=day_of_year_array,
lat=latitude_array,
sunrise_hour=sunrise_hour_array,
daylight_hours=daylight_hours_array
)
verma_net_radiation_table
Description:
Processes a DataFrame containing inputs for Verma net radiation calculations and appends the results as new columns.
Parameters:
verma_net_radiation_inputs_df(DataFrame): A DataFrame containing the following columns:Rg: Incoming shortwave radiation (W/m²).albedo: Surface albedo (unitless, constrained between 0 and 1).ST_C: Surface temperature in Celsius.EmisWBoremissivity: Surface emissivity (unitless, constrained between 0 and 1).Ta_C: Air temperature in Celsius.RH: Relative humidity (fractional, e.g., 0.5 for 50%).
Returns:
DataFrame: A copy of the input DataFrame with additional columns for the calculated radiation components:SWout: Outgoing shortwave radiation (W/m²).LWin: Incoming longwave radiation (W/m²).LWout: Outgoing longwave radiation (W/m²).Rn: Instantaneous net radiation (W/m²).
Example:
output_df = verma_net_radiation_table(input_df)
References
Brutsaert, W. (1975). On a Derivable Formula for Long‐Wave Radiation from Clear Skies. Water Resources Research, 11(5), 742–744. https://doi.org/10.1029/WR011i005p00742
Empirical model for clear-sky atmospheric emissivity, used in the calculation of incoming longwave radiation.
Liou, K. N. (2002). An Introduction to Atmospheric Radiation (2nd ed.). Academic Press. (See Eq. 2.3.1)
Textbook reference for the Stefan-Boltzmann Law and radiative transfer theory, used for outgoing longwave radiation calculations.
Stefan, J. (1879). Über die Beziehung zwischen der Wärmestrahlung und der Temperatur. Sitzungsberichte der mathematisch-naturwissenschaftlichen Classe der kaiserlichen Akademie der Wissenschaften, 79, 391–428.
Original publication of the Stefan-Boltzmann Law, fundamental to blackbody radiation calculations.
Verma, M., Fisher, J. B., Mallick, K., Ryu, Y., Kobayashi, H., Guillaume, A., Moore, G., Ramakrishnan, L., Hendrix, V. C., Wolf, S., Sikka, M., Kiely, G., Wohlfahrt, G., Gielen, B., Roupsard, O., Toscano, P., Arain, A., & Cescatti, A. (2016). Global surface net-radiation at 5 km from MODIS Terra. Remote Sensing, 8, 739. Link
Primary methodology for net radiation and daylight upscaling as implemented in this package.
Metadata
Release files for verma-net-radiation 1.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| verma_net_radiation-1.11.0.tar.gz | 793.5 kB | Without provenance | Details for verma_net_radiation-1.11.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| verma_net_radiation-1.11.0-py3-none-any.whl | Python 3 | none | any | Details for verma_net_radiation-1.11.0-py3-none-any.whl |
Total release size: 1.6 MB
Release files / verma_net_radiation-1.11.0.tar.gz
| Download URL | verma_net_radiation-1.11.0.tar.gz |
|---|---|
| Size | 793.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
88fa9d850a18ad2339dd1633ccec4ab35cbebf8fee65b63ccd08931eae791078
|
|
BLAKE2b-256 checksum How to use checksums |
369c271ffe4610acbe20fa34e6f59ec5cb8c98fd71a5d3a268ee6c5fe6bbecbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / verma_net_radiation-1.11.0-py3-none-any.whl
| Download URL | verma_net_radiation-1.11.0-py3-none-any.whl |
|---|---|
| Size | 798.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c112d9ef1499d6f1ab7e0d0d7eac357991d1ed24ecbbbe05d9756404ff9606ef
|
|
BLAKE2b-256 checksum How to use checksums |
9a41825ae21e2489b56346264e8527716c549cf09cdf10c098208803316c03c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for verma-net-radiation 1.11.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.