Date Ranges¶
- --start-date DATE | DATE RANGE¶
A date or date range in when the fire started.
Examples:
pwfdf |command| --start-date 2025 pwfdf |command| --start-date 2025-06 pwfdf |command| --start-date 2025-06-11 pwfdf |command| --start-date 2025 2027 pwfdf |command| --start-date 2025-06-15 2025-08-10
- --assessment-date DATE | DATE RANGE¶
A date or date range in which the assessment was conducted.
Examples:
pwfdf |command| --assessment-date 2025 pwfdf |command| --assessment-date 2025-06 pwfdf |command| --assessment-date 2025-06-11 pwfdf |command| --assessment-date 2025 2027 pwfdf |command| --assessment-date 2025-06-15 2025-08-10
- --publication-date DATE | DATE RANGE¶
A date or date range in which the assessment was published to ScienceBase.
Examples:
pwfdf |command| --publication-date 2025 pwfdf |command| --publication-date 2025-06 pwfdf |command| --publication-date 2025-06-11 pwfdf |command| --publication-date 2025 2027 pwfdf |command| --publication-date 2025-06-15 2025-08-10
Extent¶
Options for searching well-known spatial regions whose coordinates are already known by ScienceBase.
- --extent NAME¶
The name of an extent (such as a state or country) to search. Place the name in quotes if it contains spaces or punctuation. Cannot be used if the
--extent-idoption is used.Examples:
# Named extents pwfdf |command| --extent California pwfdf |command| --extent "Los Angeles, CA" pwfdf |command| --extent "Grand Canyon National Park" # Hydrologic unit codes pwfdf |command| --extent 05
- --extent-id ID¶
The ID of an extent to search. Cannot be used if the
--extentoption is used.Example:
# Searches California pwfdf |command| --extent-id 35 # Searches the 05 HUC-2 watershed pwfdf |command| --extent-id 2000387
- --extent-type TYPE¶
The type of extent to search. This option is usually not necessary, but can guard against searching a wrong extent with a similar name.
Tip
Use the pwfdf extents types command to obtain a list of supported types.
Example:
pwfdf |command| --extent "Los Angeles, CA" --extent-type "U.S. County"
- --extent-relation RELATION¶
The spatial relationship between the extent and the search results. Options are:
Relation
Description
intersects(default)Matches assessments that intersect the extent at any point.
withinMatches assessments that are fully contained within the extent.
disjointMatches assessments that do not intersect the extent at any point.
Example:
pwfdf |command| --extent California --extent-relation within
Geometry¶
Custom geospatial searches in which you provide the coordinates of the region to search.
- --bbox PATH | "XMIN, YMIN, XMAX, YMAX"¶
A bounding box to search. Usually the path to a supported GIS file, such as a Shapefile or GeoJSON. May also be a comma-delimited, WGS-84
"XMIN, YMIN, XMAX, YMAX"coordinate sequence. If a GIS file, then the bounding box is calculated from the contained geometries.Examples:
pwfdf |command| --bbox path/to/my/file.shp pwfdf |command| --bbox "-121, 32, -119, 34"
- --point PATH | "LON, LAT"¶
A geospatial point to search. Either a comma-delimited
"LON, LAT"sequence, or the path to a supported GIS file, such as a Shapefile or GeoJSON. If a GIS file, then the point is calculated as the center of the bounding box for the contained geometries.Examples:
pwfdf |command| --point path/to/my/file.shp pwfdf |command| --point "-121, 32"
- --geometry PATH | GEOJSON¶
A spatial geometry to search. Usually the path to a file in a supported GIS file, such as a Shapefile or GeoJSON. May also be a valid WGS-84 GeoJSON geometry string, but this syntax is generally not recommended, as it is difficult to use in practice.
In practice, only relatively coarse geometries are supported, as the geometry cannot cause the underlying query URL to exceed 2000 characters. As a rule of thumb, geometries with fewer than 100 coordinate points are expected to usually work.
Examples:
pwfdf |command| --geometry path/to/my/file.shp pwfdf |command| --geometry "{\"type\":\"Point\",\"coordinates\":[-121, 32]}"
- --geometry-relation RELATION¶
The spatial relationship between a geospatial search and the search results. Options are:
Relation
Description
intersects(default)Matches assessments that intersect the geometry at any point.
withinMatches assessments that are fully contained within the geometry.
disjointMatches assessments that do not intersect the geometry at any point.
Example:
pwfdf |command| --bbox my-file.shp --geometry-relation intersects pwfdf |command| --point my-file.shp --geometry-relation within pwfdf |command| --geometry my-file.shp --geometry-relation disjoint
Geometry File IO¶
Options for reading geometries from supported vector feature file formats.
- --geometry-layer NAME¶
The name of a data layer in the GIS file from which to extract the geometry. Cannot be used when the
--geometry-indexoption is used.Example:
pwfdf |command| --geometry my-file.geojson --geometry-layer "My Data Layer"
- --geometry-index INDEX¶
The index of a data layer in the GIS file from which to extract the geometry. Cannot be used when the
--geometry-layeroption is used.Example:
pwfdf |command| --geometry my-file.geojson --geometry-index 2
- --geometry-driver DRIVER¶
Specifies the file format driver to use to open the geometry file. Note that the format driver is usually auto-detected from the file extension. Use this option if the geometry file uses a non-standard file extension. Refer to the first column of the geometry file formats table for a list of supported driver names.
Example:
pwfdf |command| --geometry my-file.unusual --geometry-driver Shapefile
- --geometry-encoding ENCODING¶
Specifies the file encoding to use to read the geometry file. Note that the encoding is auto-detected for most formats.
Example:
pwfdf |command| --geometry my-file.shp --geometry-encoding Windows-1252