Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 99 additions & 0 deletions docs/source/datasets/frap_fire_perimeters.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
.. This file is generated by scripts/render_dataset_docs.py. Do not edit by hand.

FRAP Fire Perimeters
====================

California's authoritative historical fire perimeter archive maintained by CAL FIRE FRAP.

Overview
--------

FRAP Fire Perimeters is CAL FIRE's statewide historical perimeter archive for large fires and other mapped wildfire events in California.

In PyHazards it serves as a regional authoritative perimeter source for wildfire evaluation, event backfilling, and comparison against national incident feeds such as WFIGS or satellite detections such as FIRMS.

At a Glance
-----------

.. list-table::
:widths: 28 72
:stub-columns: 1

* - Provider
- CAL FIRE / Fire and Resource Assessment Program (FRAP)
* - Hazard Family
- Wildfire
* - Source Role
- Historical Perimeters
* - Coverage
- California
* - Geometry
- Vector fire perimeter polygons
* - Spatial Resolution
- Event-level polygon geometries
* - Temporal Resolution
- Event-based historical perimeter archive
* - Update Cadence
- Annual spring releases with new fire-season perimeters
* - Period of Record
- Historical California fire perimeter archive spanning multiple decades
* - Formats
- Shapefile, file geodatabase downloads, and zipped GIS packages
* - Inspection CLI
- ``ogrinfo -so "/home/runyang/ryang/FRAP_Fire_Perimeters/shapefile/California_Fire_Perimeters_(all).shp" "California_Fire_Perimeters_(all)"``

Data Characteristics
--------------------

- Statewide polygon archive focused on historical fire perimeters.
- More suitable for perimeter validation and retrospective analysis than for near-real-time detection.
- Includes known completeness limitations for older fires and should be interpreted with source caveats in mind.
- Complements national incident feeds by providing California-specific historical depth.

Typical Use Cases
~~~~~~~~~~~~~~~~~

- Historical wildfire perimeter validation in California.
- Regional benchmark label curation and retrospective fire footprint analysis.
- Cross-checking incident records against mapped burn extents.

Access
------

Use the links below to access the upstream source or its public documentation.

- `CAL FIRE FRAP Fire Perimeters <https://www.fire.ca.gov/what-we-do/fire-resource-assessment-program/fire-perimeters>`_
- `CAL FIRE Fire Perimeters metadata <https://map.dfg.ca.gov/metadata/ds0396.html>`_

PyHazards Usage
---------------

Use the local shapefile or zipped archive as an external inspection-first source when you need California-specific historical perimeters in wildfire workflows.

This dataset is currently documented as an external or inspection-first
source rather than a public ``load_dataset(...)`` entrypoint.

Related Coverage
~~~~~~~~~~~~~~~~

**Benchmarks:** :doc:`Wildfire Benchmark </benchmarks/wildfire_benchmark>`

Inspection Workflow
-------------------

Use the documented inspection path below to validate local files before training or analysis.

.. code-block:: bash

ogrinfo -so "/home/runyang/ryang/FRAP_Fire_Perimeters/shapefile/California_Fire_Perimeters_(all).shp" "California_Fire_Perimeters_(all)"

Notes
-----

- FRAP is especially useful when you want a California-specific historical perimeter reference in addition to national feeds.
- Local copy detected at ``/home/runyang/ryang/FRAP_Fire_Perimeters``.

Reference
---------

- `CAL FIRE FRAP Fire Perimeters <https://www.fire.ca.gov/what-we-do/fire-resource-assessment-program/fire-perimeters>`_.
98 changes: 98 additions & 0 deletions docs/source/datasets/geomac_historical.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
.. This file is generated by scripts/render_dataset_docs.py. Do not edit by hand.

GeoMAC Historical
=================

Historical GeoMAC wildfire perimeters preserved as a legacy U.S. perimeter archive for long-horizon evaluation.

Overview
--------

GeoMAC Historical packages legacy wildfire perimeter archives that predate newer interagency operational feeds.

In PyHazards it acts as a historical archive source for long-range retrospective wildfire evaluation, especially when you need older national perimeter context before newer incident systems became standard.

At a Glance
-----------

.. list-table::
:widths: 28 72
:stub-columns: 1

* - Provider
- Legacy GeoMAC / USGS-hosted historical archive
* - Hazard Family
- Wildfire
* - Source Role
- Historical Perimeters
* - Coverage
- United States
* - Geometry
- Archived wildfire perimeter polygons
* - Spatial Resolution
- Event-level perimeter geometries
* - Temporal Resolution
- Event-based archive
* - Update Cadence
- Legacy archive; local copy is static
* - Period of Record
- Local archive includes 2000-2018 plus 2019 packages
* - Formats
- ZIP archives containing GIS perimeter products
* - Inspection CLI
- ``unzip -l "/home/runyang/ryang/GeoMAC_Historical/Historic_Geomac_Perimeters_All_Years_2000_2018/Historic_Geomac_Perimeters_All_Years_2000_2018.zip" | head``

Data Characteristics
--------------------

- Legacy archive rather than a live operational feed.
- Useful for extending historical perimeter coverage when evaluating older wildfire seasons.
- Typically consumed after extraction into standard GIS formats.
- Best paired with newer systems such as WFIGS for post-2019 workflows.

Typical Use Cases
~~~~~~~~~~~~~~~~~

- Long-horizon historical wildfire perimeter studies.
- Retrospective perimeter benchmarking across older U.S. wildfire seasons.
- Gap-filling historical archives before newer interagency feeds.

Access
------

Use the links below to access the upstream source or its public documentation.

- `USGS Data Series 612: GeoMAC wildfire perimeters <https://pubs.usgs.gov/publication/ds612>`_

PyHazards Usage
---------------

Use the local archives as an external inspection-first source when older U.S. wildfire perimeter history is needed.

This dataset is currently documented as an external or inspection-first
source rather than a public ``load_dataset(...)`` entrypoint.

Related Coverage
~~~~~~~~~~~~~~~~

**Benchmarks:** :doc:`Wildfire Benchmark </benchmarks/wildfire_benchmark>`

Inspection Workflow
-------------------

Use the documented inspection path below to validate local files before training or analysis.

.. code-block:: bash

unzip -l "/home/runyang/ryang/GeoMAC_Historical/Historic_Geomac_Perimeters_All_Years_2000_2018/Historic_Geomac_Perimeters_All_Years_2000_2018.zip" | head

Notes
-----

- GeoMAC Historical is a legacy archive and should be treated as a historical reference rather than a live feed.
- Local copy detected at ``/home/runyang/ryang/GeoMAC_Historical``.

Reference
---------

- `USGS Data Series 612: GeoMAC wildfire perimeters <https://pubs.usgs.gov/publication/ds612>`_.
85 changes: 85 additions & 0 deletions docs/source/datasets/goes_geocolor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
.. This file is generated by scripts/render_dataset_docs.py. Do not edit by hand.

GOES GeoColor
=============

NOAA GOES-East/West GeoColor imagery source used for visual fire-scene context.

Overview
--------

GOES GeoColor imagery combines visible and infrared channels into an easy-to-interpret geostationary imagery product.

In PyHazards it acts as wildfire scene context imagery for visual verification, event inspection, and qualitative comparison against fire and smoke products.

At a Glance
-----------

.. list-table::
:widths: 28 72
:stub-columns: 1

* - Provider
- NOAA GOES / CIRA GeoColor imagery services
* - Hazard Family
- Shared Forcing
* - Source Role
- Satellite Imagery Context
* - Coverage
- GOES-East/West views over the Americas
* - Geometry
- Geostationary imagery time series
* - Spatial Resolution
- ABI imagery resolution on the fixed grid
* - Temporal Resolution
- About every 10 minutes
* - Update Cadence
- Continuous ingest as new imagery becomes available
* - Period of Record
- Local copy spans 2017-2026 with GOES-18 subset on disk
* - Formats
- Image products and derived imagery files
* - Inspection CLI
- ``find /home/runyang/ryang/GOES_GeoColor_CIRA -maxdepth 3 -type f | head``

Data Characteristics
--------------------

- Visual-context imagery rather than direct fire detections.
- Useful for scene interpretation, plume verification, and rapid event review.
- High temporal refresh over the geostationary domain.
- Best paired with GOES-R FDCF or HMS smoke products.

Typical Use Cases
~~~~~~~~~~~~~~~~~

- Visual wildfire scene context.
- Smoke and plume inspection.
- Manual event triage and QA.

Access
------

- `CIRA Slider <https://rammb-slider.cira.colostate.edu/>`_

PyHazards Usage
---------------

Use this imagery archive as an inspection-first visual context source.

Related Coverage
~~~~~~~~~~~~~~~~

**Benchmarks:** :doc:`Wildfire Benchmark </benchmarks/wildfire_benchmark>`

Inspection Workflow
-------------------

.. code-block:: bash

find /home/runyang/ryang/GOES_GeoColor_CIRA -maxdepth 3 -type f | head

Notes
-----

- Local copy detected at ``/home/runyang/ryang/GOES_GeoColor_CIRA``.
99 changes: 99 additions & 0 deletions docs/source/datasets/goesr_fdcf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
.. This file is generated by scripts/render_dataset_docs.py. Do not edit by hand.

GOES-R FDCF
===========

GOES-R ABI Fire/Hot Spot Characterization files used for high-frequency active-fire monitoring across the Americas.

Overview
--------

GOES-R FDCF is the ABI Fire/Hot Spot Characterization product from the GOES-R series, providing rapid-refresh geostationary active-fire and hot-spot information.

In PyHazards it serves as a wildfire-specific geostationary fire-monitoring source that complements FIRMS with much higher refresh frequency over the GOES-East and GOES-West domains.

At a Glance
-----------

.. list-table::
:widths: 28 72
:stub-columns: 1

* - Provider
- NOAA GOES-R Series / ABI
* - Hazard Family
- Wildfire
* - Source Role
- Geostationary Active Fire
* - Coverage
- GOES-East and GOES-West full-disk views over the Americas
* - Geometry
- Geostationary raster NetCDF time series
* - Spatial Resolution
- Product pixels at geostationary ABI resolution (roughly kilometer-scale at nadir)
* - Temporal Resolution
- About every 10 minutes for full-disk scans
* - Update Cadence
- Continuous operational production as new scans arrive
* - Period of Record
- GOES-16 and GOES-18 operational era
* - Formats
- NetCDF
* - Inspection CLI
- ``python -m pyhazards.datasets.goesr.inspection --path /home/runyang/ryang/GOES_FDCF_G16/2024 --max-items 10``

Data Characteristics
--------------------

- Geostationary fire monitoring with much higher temporal refresh than polar-orbiting active-fire products.
- Product is especially useful for tracking rapidly evolving wildfire activity.
- Domain is regional rather than global, tied to GOES-East and GOES-West views.
- Best used alongside FIRMS, incident records, and perimeter archives.

Typical Use Cases
~~~~~~~~~~~~~~~~~

- Rapid-refresh wildfire activity monitoring.
- Temporal alignment of fire activity with smoke and weather products.
- Cross-checking high-frequency fire dynamics against FIRMS hotspots.

Access
------

Use the links below to access the upstream source or its public documentation.

- `GOES-R Fire/Hot Spot Characterization product <https://goes-r.noaa.gov/products/baseline-fire-hot-spot.html>`_
- `GOES-R product page at NOAA STAR <https://www.star.nesdis.noaa.gov/goesr/product_land_fire.php>`_

PyHazards Usage
---------------

Use the local GOES-East and GOES-West NetCDF archive as an external inspection-first source for high-frequency wildfire monitoring workflows.

This dataset is currently documented as an external or inspection-first
source rather than a public ``load_dataset(...)`` entrypoint.

Related Coverage
~~~~~~~~~~~~~~~~

**Benchmarks:** :doc:`Wildfire Benchmark </benchmarks/wildfire_benchmark>`

Inspection Workflow
-------------------

Use the documented inspection path below to validate local files before training or analysis.

.. code-block:: bash

python -m pyhazards.datasets.goesr.inspection --path /home/runyang/ryang/GOES_FDCF_G16/2024 --max-items 10

Notes
-----

- GOES-R FDCF complements FIRMS by trading lower spatial precision for much higher temporal refresh.
- Local copies detected at ``/home/runyang/ryang/GOES_FDCF_G16`` and ``/home/runyang/ryang/GOES_FDCF_G18``.

Reference
---------

- `GOES-R Fire/Hot Spot Characterization product <https://goes-r.noaa.gov/products/baseline-fire-hot-spot.html>`_.
Loading
Loading