Skip to main content
Ctrl+K

easysnowdata

  • Installation
  • Concepts
  • Credentials
  • Migrating from 0.0.x
  • FAQ
  • Example gallery
    • Data catalog
    • Source status
    • API reference
    • Long-form notebooks
    • Contributing
    • Releasing
    • Changelog
  • GitHub
  • PyPI
  • Installation
  • Concepts
  • Credentials
  • Migrating from 0.0.x
  • FAQ
  • Example gallery
  • Data catalog
  • Source status
  • API reference
  • Long-form notebooks
  • Contributing
  • Releasing
  • Changelog
  • GitHub
  • PyPI

Section Navigation

  • Areas of interest
    • easysnowdata.aoi.AOI
    • easysnowdata.aoi.parse_aoi
    • easysnowdata.aoi.estimate_utm_crs
    • easysnowdata.aoi.split_antimeridian
  • Credentials
    • easysnowdata.auth.CredentialError
    • easysnowdata.auth.Detection
    • easysnowdata.auth.Provider
    • easysnowdata.auth.get
    • easysnowdata.auth.detect
    • easysnowdata.auth.status
    • easysnowdata.auth.login
    • easysnowdata.auth.ensure
    • easysnowdata.auth.env
    • easysnowdata.auth.reset
    • easysnowdata.auth.summary_line
  • Catalog
    • easysnowdata.catalog.Variable
    • easysnowdata.catalog.Probe
    • easysnowdata.catalog.Source
    • easysnowdata.catalog.Product
    • easysnowdata.catalog.register
    • easysnowdata.catalog.products
    • easysnowdata.catalog.get
    • easysnowdata.catalog.list
    • easysnowdata.catalog.search
    • easysnowdata.catalog.describe
    • easysnowdata.catalog.themes
    • easysnowdata.catalog.validate
    • easysnowdata.catalog.validate_all
    • easysnowdata.catalog.health.http_first_byte
    • easysnowdata.catalog.health.stac_search
    • easysnowdata.catalog.health.zarr_metadata
    • easysnowdata.catalog.health.gee_asset
    • easysnowdata.catalog.health.earthdata_search
    • easysnowdata.catalog.health.stac_latest
    • easysnowdata.catalog.health.cmr_latest
    • easysnowdata.catalog.health.zarr_latest
    • easysnowdata.catalog.health.gee_latest
    • easysnowdata.catalog.health.latest_available_day
    • easysnowdata.catalog.health.dmrpp_status
    • easysnowdata.catalog.health.run
    • easysnowdata.catalog.health.update_history
    • easysnowdata.catalog.health.summarize
    • easysnowdata.catalog.health.main
  • Configuration
    • easysnowdata.config.quiet
    • easysnowdata.config.is_interactive
    • easysnowdata.config.cache_dir
    • easysnowdata.config.Region
    • easysnowdata.config.region
    • easysnowdata.config.access_mode
  • Time inputs
    • easysnowdata.temporal.parse_time
    • easysnowdata.temporal.to_stac_datetime
    • easysnowdata.temporal.today
    • easysnowdata.temporal.now
  • Stations
    • easysnowdata.stations.inventory
    • easysnowdata.stations.load
    • easysnowdata.stations.metadata
    • easysnowdata.stations.archive.csv_url
    • easysnowdata.stations.archive.inventory
    • easysnowdata.stations.archive.load
    • easysnowdata.stations.archive.network_of
    • easysnowdata.stations.clients.AWDBClient
    • easysnowdata.stations.clients.AWDBError
    • easysnowdata.stations.clients.CDECClient
    • easysnowdata.stations.clients.CDECError
    • easysnowdata.stations.clients.DataBCClient
    • easysnowdata.stations.clients.DataBCError
    • easysnowdata.stations.clients.NVEClient
    • easysnowdata.stations.clients.NVEError
    • easysnowdata.stations.clients.YukonClient
    • easysnowdata.stations.clients.YukonError
    • easysnowdata.stations.networks.Network
    • easysnowdata.stations.networks.canonical_units
    • easysnowdata.stations.networks.get
    • easysnowdata.stations.networks.split_by_network
    • easysnowdata.stations.networks.to_code
    • easysnowdata.stations.networks.to_station_id
  • Snow
    • easysnowdata.snow.modis.search
    • easysnowdata.snow.modis.load
    • easysnowdata.snow.mountain_snow_mask.load
    • easysnowdata.snow.snodas.tar_url
    • easysnowdata.snow.snodas.search
    • easysnowdata.snow.snodas.load
    • easysnowdata.snow.snow_classification.filename
    • easysnowdata.snow.snow_classification.load
    • easysnowdata.snow.ucla_sr.search
    • easysnowdata.snow.ucla_sr.load
    • easysnowdata.snow.viirs.search
    • easysnowdata.snow.viirs.load
    • easysnowdata.snow.viirs.read_struct_metadata
  • SAR
    • easysnowdata.sar.sentinel1.search
    • easysnowdata.sar.sentinel1.load
    • easysnowdata.sar.sentinel1.local_incidence_angle
  • Optical
    • easysnowdata.optical.hls.search
    • easysnowdata.optical.hls.load
    • easysnowdata.optical.planetscope.search
    • easysnowdata.optical.planetscope.order
    • easysnowdata.optical.planetscope.load
    • easysnowdata.optical.planetscope.open_delivery
    • easysnowdata.optical.sentinel2.search
    • easysnowdata.optical.sentinel2.load
  • Terrain
    • easysnowdata.terrain.chili.load
    • easysnowdata.terrain.dem.search
    • easysnowdata.terrain.dem.load
  • Land cover
    • easysnowdata.land.forest_cover.load
    • easysnowdata.land.landcover.search
    • easysnowdata.land.landcover.load
    • easysnowdata.land.nlcd.load
  • Hydrography
    • easysnowdata.hydro.basins.huc
    • easysnowdata.hydro.basins.hydrobasins
    • easysnowdata.hydro.basins.grdc_major
    • easysnowdata.hydro.basins.grdc_wmo
    • easysnowdata.hydro.basins.load
  • Climate
    • easysnowdata.climate.era5.search
    • easysnowdata.climate.era5.load
    • easysnowdata.climate.koppen_geiger.search
    • easysnowdata.climate.koppen_geiger.load
  • Processing
    • easysnowdata.processing.add_water_year_coords
    • easysnowdata.processing.apply_fmask
    • easysnowdata.processing.binary_snow
    • easysnowdata.processing.apply_scl_mask
    • easysnowdata.processing.day_of_water_year
    • easysnowdata.processing.db_to_linear
    • easysnowdata.processing.decode_udm2
    • easysnowdata.processing.evi
    • easysnowdata.processing.flag_mask
    • easysnowdata.processing.flags
    • easysnowdata.processing.fmask_aerosol_level
    • easysnowdata.processing.fmask_bit
    • easysnowdata.processing.fmask_mask
    • easysnowdata.processing.from_class_info
    • easysnowdata.processing.harmonize_s2_baseline
    • easysnowdata.processing.linear_to_db
    • easysnowdata.processing.local_incidence_angle
    • easysnowdata.processing.look_azimuth
    • easysnowdata.processing.mask_nodata
    • easysnowdata.processing.ndbi
    • easysnowdata.processing.ndsi
    • easysnowdata.processing.ndvi
    • easysnowdata.processing.ndwi
    • easysnowdata.processing.ndsi_flag_attrs
    • easysnowdata.processing.normalized_difference
    • easysnowdata.processing.parse_snodas_header
    • easysnowdata.processing.remove_border_noise
    • easysnowdata.processing.rgb
    • easysnowdata.processing.scale_offset
    • easysnowdata.processing.scl_mask
    • easysnowdata.processing.set_flags
    • easysnowdata.processing.slope_aspect
    • easysnowdata.processing.stretch_clahe
    • easysnowdata.processing.stretch_percentile
    • easysnowdata.processing.udm1_bit
    • easysnowdata.processing.water_year
    • easysnowdata.processing.water_year_start
    • easysnowdata.processing.categorical.meaning_key
    • easysnowdata.processing.contract.geographic_dims
    • easysnowdata.processing.contract.write_crs
    • easysnowdata.processing.contract.mask_continuous
    • easysnowdata.processing.contract.set_categorical_nodata
    • easysnowdata.processing.contract.provenance
    • easysnowdata.processing.contract.apply_variables
    • easysnowdata.processing.contract.finalize
    • easysnowdata.processing.snow.repair_fill_values
    • easysnowdata.processing.snow.snodas_members
    • easysnowdata.processing.snow.snodas_array
    • easysnowdata.processing.wateryear.water_year_bounds
    • easysnowdata.processing.wateryear.water_year_range
    • easysnowdata.processing.wateryear.water_year_length
  • Plotting
    • easysnowdata.plotting.colormap_from_flags
    • easysnowdata.plotting.legend_handles
    • easysnowdata.plotting.categorical
    • easysnowdata.plotting.register_colormap
    • easysnowdata.plotting.rgb
  • Providers
    • easysnowdata.providers.gdal_env
    • easysnowdata.providers.stac.open_catalog
    • easysnowdata.providers.stac.search
    • easysnowdata.providers.stac.items_to_geodataframe
    • easysnowdata.providers.stac.geodataframe_to_items
    • easysnowdata.providers.stac.load
    • easysnowdata.providers.stac.odc_load
    • easysnowdata.providers.stac.read_env
    • easysnowdata.providers.earthdata.ensure
    • easysnowdata.providers.earthdata.env
    • easysnowdata.providers.earthdata.search
    • easysnowdata.providers.earthdata.granules_to_geodataframe
    • easysnowdata.providers.earthdata.open
    • easysnowdata.providers.earthdata.download
    • easysnowdata.providers.earthdata.hdf4_available
    • easysnowdata.providers.earthdata.require_hdf4
    • easysnowdata.providers.gee.ensure
    • easysnowdata.providers.gee.ee
    • easysnowdata.providers.gee.grid_params
    • easysnowdata.providers.gee.open_dataset
    • easysnowdata.providers.gee.features_to_geodataframe
    • easysnowdata.providers.gee.geometry
    • easysnowdata.providers.planet.ensure
    • easysnowdata.providers.planet.client
    • easysnowdata.providers.planet.sdk
    • easysnowdata.providers.planet.build_search_filter
    • easysnowdata.providers.planet.search
    • easysnowdata.providers.planet.items_to_geodataframe
    • easysnowdata.providers.planet.product
    • easysnowdata.providers.planet.create_order
    • easysnowdata.providers.planet.wait_order
    • easysnowdata.providers.planet.download_order
    • easysnowdata.providers.planet.asset_url
    • easysnowdata.providers.raster_http.open
    • easysnowdata.providers.raster_http.zip_url
    • easysnowdata.providers.raster_http.fetch
    • easysnowdata.providers.zarr_cloud.storage_options_for
    • easysnowdata.providers.zarr_cloud.open
    • easysnowdata.providers.zarr_cloud.select
    • easysnowdata.providers.vector_http.read
    • easysnowdata.providers.vector_http.read_parquet
    • easysnowdata.providers.vector_http.zip_path
  • remote_sensing (deprecated)
    • easysnowdata.remote_sensing.authenticate_all
    • easysnowdata.remote_sensing.get_forest_cover_fraction
    • easysnowdata.remote_sensing.get_seasonal_snow_classification
    • easysnowdata.remote_sensing.get_seasonal_mountain_snow_mask
    • easysnowdata.remote_sensing.get_esa_worldcover
    • easysnowdata.remote_sensing.get_nlcd_landcover
    • easysnowdata.remote_sensing.Sentinel2
    • easysnowdata.remote_sensing.Sentinel1
    • easysnowdata.remote_sensing.HLS
    • easysnowdata.remote_sensing.MODIS_snow
  • hydroclimatology (deprecated)
    • easysnowdata.hydroclimatology.get_huc_geometries
    • easysnowdata.hydroclimatology.get_hydroBASINS
    • easysnowdata.hydroclimatology.get_grdc_major_river_basins_of_the_world
    • easysnowdata.hydroclimatology.get_grdc_wmo_basins
    • easysnowdata.hydroclimatology.get_era5
    • easysnowdata.hydroclimatology.get_snodas
    • easysnowdata.hydroclimatology.get_ucla_snow_reanalysis
    • easysnowdata.hydroclimatology.get_koppen_geiger_classes
  • topography (deprecated)
    • easysnowdata.topography.get_copernicus_dem
    • easysnowdata.topography.get_chili
  • automatic_weather_stations (deprecated)
    • easysnowdata.automatic_weather_stations.StationCollection
  • utils (deprecated)
    • easysnowdata.utils.requires_earthengine
    • easysnowdata.utils.requires_earthaccess
    • easysnowdata.utils.initialize_earthengine
    • easysnowdata.utils.suppress_stdout
    • easysnowdata.utils.convert_bbox_to_geodataframe
    • easysnowdata.utils.get_ee_grid_params
    • easysnowdata.utils.get_stac_cfg
    • easysnowdata.utils.get_water_year_start
    • easysnowdata.utils.datetime_to_DOWY
    • easysnowdata.utils.datetime_to_WY
    • easysnowdata.utils.HLS_xml_url_to_metadata_df
  • API reference
  • Optical
  • easysnowdata.optical.sentinel2.search

easysnowdata.optical.sentinel2.search#

easysnowdata.optical.sentinel2.search(aoi: Any = None, time: Any = None, *, source: str | None = None, collection: str | None = None, cloud_cover: float | None = None, query: dict[str, Any] | None = None, max_items: int | None = None, **kwargs: Any) → GeoDataFrame[source]#

Search one of the catalogs and return the items as a GeoDataFrame.

The frame carries every STAC property as a column plus stac_item, so it can be filtered and handed straight to load().

Parameters:
  • aoi – The usual spatial and temporal inputs.

  • time – The usual spatial and temporal inputs.

  • source – "planetary-computer" (default) or "earth-search".

  • collection – A collection of that catalog (Earth Search also has "sentinel-2-c1-l2a" and "sentinel-2-pre-c1-l2a").

  • cloud_cover – Keep scenes with eo:cloud_cover below this percentage.

  • query – Passed to easysnowdata.providers.stac.search().

  • max_items – Passed to easysnowdata.providers.stac.search().

  • **kwargs – Passed to easysnowdata.providers.stac.search().

previous

easysnowdata.optical.planetscope.open_delivery

next

easysnowdata.optical.sentinel2.load

On this page
  • search()
Edit on GitHub

© Copyright 2026, Eric Gagliano.

Built with the PyData Sphinx Theme 0.21.0.