Skip to main content

Harmonized Landsat Sentinel (HLS) search and download utility

Project description

Harmonized Landsat Sentinel (HLS) Python Search and Download Utility

CI

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

Margaret C. Johnson (she/her)
maggie.johnson@jpl.nasa.gov
NASA Jet Propulsion Laboratory

Evan Davis (he/him)
evan.w.davis@jpl.nasa.gov
NASA Jet Propulsion Laboratory 397K

Installation

This package is available on PyPi: https://pypi.org/project/harmonized-landsat-sentinel

pip install harmonized-landsat-sentinel

Skip all-NaN outputs

When cloud masks and nodata filtering produce rasters with no valid pixels, you can skip writing those files:

from harmonized_landsat_sentinel import generate_HLS_timeseries

generate_HLS_timeseries(
   start_date_UTC="2022-08-01",
   end_date_UTC="2022-08-02",
   geometry=grid,
   output_directory="~/data/Kings_Canyon_HLS",
   source="both",
   skip_all_nan=True,
)

CLI:

hls --start 2022-08-01 --end 2022-08-02 --skip-all-nan

How to Cite This Package

If you use this software in a publication, please cite the specific release/version you used.

Suggested software citation:

LaTeX (BibTeX) entry:

@software{halverson2026hls,
   author  = {Halverson, Gregory H. and Johnson, Margaret C. and Davis, Evan},
   title   = {{harmonized-landsat-sentinel}},
   year    = {2026},
   version = {2.3.0},
   url     = {https://github.com/STARS-Data-Fusion/harmonized-landsat-sentinel},
   note    = {Computer software}
}

For machine-readable citation metadata, see CITATION.cff in this repository.

References

If you use this package to access or analyze the Harmonized Landsat Sentinel (HLS) dataset, please cite the following datasets and research articles:

Data Citations

  • HLS v2.0 (L30 and S30):
    NASA Goddard Space Flight Center; U.S. Geological Survey. (2022). Harmonized Landsat Sentinel-2 (HLS) Product, Version 2.0 [Dataset]. NASA LP DAAC. https://doi.org/10.5067/HLS/HLS.020

Peer-Reviewed Articles

  1. Roy, D. P., Li, J., Zhang, H. K., & Yan, L. (2016). The Harmonized Landsat and Sentinel-2 (HLS) Product: An Analytical Framework for Characterizing Land Cover Using Satellite Remote Sensing. Remote Sensing of Environment, 176, 152-171. https://doi.org/10.1016/j.rse.2015.12.024
    This foundational article presents the analytical framework for harmonizing Landsat and Sentinel-2 data, discussing challenges in land cover characterization and product development.

  2. Claverie, M., Ju, J., Masek, J. G., Dungan, J. L., Vermote, E. F., Roger, J. C., Skakun, S., & Justice, C. O. (2018). Harmonized Landsat-8 Sentinel-2 Products for Land Monitoring. Remote Sensing of Environment, 219, 145-161. https://doi.org/10.1016/j.rse.2018.09.002
    This article describes the harmonization process, atmospheric correction, and band alignment used in generating the HLS products.

  3. Feng, M., Vermote, E. F., & Masek, J. G. (2020). Harmonized Landsat Sentinel-2 Data for Monitoring Global Agriculture. Remote Sensing, 12(22), 3684. https://doi.org/10.3390/rs12223684
    This paper highlights applications of HLS in agricultural monitoring, with validation studies that underscore its importance for tracking global agricultural patterns.

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

harmonized_landsat_sentinel-2.3.1.tar.gz (4.0 MB view details)

Uploaded Source

Built Distribution

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

harmonized_landsat_sentinel-2.3.1-py3-none-any.whl (35.7 kB view details)

Uploaded Python 3

File details

Details for the file harmonized_landsat_sentinel-2.3.1.tar.gz.

File metadata

File hashes

Hashes for harmonized_landsat_sentinel-2.3.1.tar.gz
Algorithm Hash digest
SHA256 aa9272f9aeb249422753421f5a90000bce0b45f471b161b13f76e0ccbe0c3f33
MD5 ac31ea67dfb172d2828963d48e5206a5
BLAKE2b-256 27d825457fcec0f081e53e09e558c0f7ce829b8ee7bac883b48f7a859d45d256

See more details on using hashes here.

File details

Details for the file harmonized_landsat_sentinel-2.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for harmonized_landsat_sentinel-2.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7bd30bb6598fb5579d9adafccded76b24693ae6a17e2586abfaea8765b4afae5
MD5 f411e518aa6a24b3cf1ab3be91d631e9
BLAKE2b-256 ab4588f4bcc031fb6e921c24146252bf82b546beba193140c706733ea174db8b

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