Skip to main content

Harmonized Landsat Sentinel (HLS) Python Search and Download Utility

CI

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.

Metadata

Release files for harmonized-landsat-sentinel 2.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for harmonized-landsat-sentinel 2.4.0
File Size Uploaded Provenance Actions
harmonized_landsat_sentinel-2.4.0.tar.gz 4.0 MB Without provenance Details for harmonized_landsat_sentinel-2.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for harmonized-landsat-sentinel 2.4.0
File Interpreter ABI Platform Actions
harmonized_landsat_sentinel-2.4.0-py3-none-any.whl Python 3 none any Details for harmonized_landsat_sentinel-2.4.0-py3-none-any.whl

Total release size: 4.1 MB

Release files / harmonized_landsat_sentinel-2.4.0.tar.gz

Download URL harmonized_landsat_sentinel-2.4.0.tar.gz
Size 4.0 MB
Tags Source
SHA-256 checksum
How to use checksums
3ad11f9aad3715cd4d9fe4d7bbcdb9523c2526acaa978d61df839138703cb105
BLAKE2b-256 checksum
How to use checksums
b4199f7aaf18ca5d1cc91efa13dd138d81bd7a2fa89cfd5a1c846dd6d07314fb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / harmonized_landsat_sentinel-2.4.0-py3-none-any.whl

Download URL harmonized_landsat_sentinel-2.4.0-py3-none-any.whl
Size 47.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
73409b391132d1d7177f12273dcf548373e5219d13c77a68802e704fa5ba4e74
BLAKE2b-256 checksum
How to use checksums
27332654fb7f5bb3e16357dc99bc2b184f850d53223613f52924b9f902189436
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for harmonized-landsat-sentinel 2.4.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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page