update-docs: add first draft of all docs pages#275
Merged
andersy005 merged 10 commits intomainfrom Oct 21, 2025
Merged
Conversation
…al API notes - Split configuration and type sections and clarified descriptions (Coiled, datasets, CONUS404) - Added separate Utilities (general/testing) sections and improved wording - Moved/expanded Internal API note and refined CLI wording - Update docs/index.md: mark License as "License (TK)" and tweak license phrasing
…ables, metadata, and access patterns (docs/reference/data-schema.md)
- import cartopy, matplotlib tools, shapely box and color utilities - add extent_as_tuple_5070 to provide extent in EPSG:5070 - add bbox_from_wgs84 helper - implement visualize_chunks_on_conus to render chunks on a CONUS map (supports coloring by size, highlighting, and optional background chunks) - enhance plot_all_chunks to use colormap/norm for size-based coloring and remove a stray debug print
Replace the large hard-coded list of region IDs with a dynamic generator that iterates over chunk_info, computes lat/lon slices for each chunk, and selects region IDs where the CRPS data is not all-null. Add a docstring and remove the legacy commented generator helper. This keeps valid region IDs in sync with the underlying dataset.
- Introduce a new method `get_chunks_for_bbox` on `ChunkingConfig` that returns a list of (iy, ix) chunk index tuples that intersect a given bounding box. - The method accepts either a shapely `Polygon` (or compatible geometry) or a tuple (minx, miny, maxx, maxy). Tuple inputs are validated for length and converted to a shapely `box`. - Uses existing `chunk_info` (y_chunks, x_chunks, y_starts, x_starts) and `index_to_coords` to compute each chunk's geographic bounds, builds a shapely box for each chunk (handling Y-axis orientation), and tests intersection with the provided bbox. - Returns all intersecting chunk indices as a list of (iy, ix) tuples. - Add import for `Polygon` from `shapely.geometry`. This facilitates spatial queries against the configured chunk grid.
Expand overview.md with a detailed conceptual description of the fire-risk workflow: - Define RPS (Risk to Potential Structures) and formula (BP × cRPS) - Describe wind-informed BP spreading (fire-weather analysis, elliptical kernels, iterative spreading) - List raster and vector inputs, processing steps, sampling at building locations, and categorical scoring - Document spatial chunking, outputs (GeoParquet, PMTiles, summary stats), assumptions, limitations, and references - Add links to implementation, data provenance, validation, and tutorial resources
- Add docs/how-to/getting-started.md with usage instructions, Icechunk example, dataset overview, and next steps for users, researchers, and developers. - Update mkdocs.yml: place Getting Started under User Guides and move Installation into Developer Guides. - Update docs/how-to/installation.md next-steps to remove the getting-started link and emphasize Data Pipeline and Project Structure links.
…cs section, clean up cell metadata, and update notebook kernelspec display name
andersy005
added a commit
that referenced
this pull request
Nov 4, 2025
* main: (46 commits) Chage summary stats geoparquet filepaths from `output` to `intermediate` (#299) Update data downloads page (#300) Bump prefix-dev/setup-pixi from 0.9.1 to 0.9.2 in the actions group (#298) Update data download documentation (#293) migrate vector input datasets to unified ingestion and remove unused datasets (#297) Fix duplicate `avg_name` (#296) fix California and Tennessee region IDs in staging automatic deploy (#294) Add additional region IDs to QA PR automatic deploy (#292) create a unified infrastructure for ingesting and processing input datasets (#289) Combine county, tract and block PMTiles layers into a single regions.pmtiles layer (#291) Pyramid (#284) Use buffered slices to remove edge effects from neighborhood operations (#288) Bumps up RAM for `write-aggregated-region-analysis-files` job (#290) fix block dataset path construction in wind risk regional aggregation (#282) Adds a bbox struct for region pmtiles (#281) compute Dask-backed data before assert_equal/assert_all_close (#283) pipeline and configuration improvements (#279) Add cached valid_region_ids.json and use it in ChunkingConfig (#280) Combining wind-smeared data and Riley BP + smoothing (#278) update-docs: add first draft of all docs pages (#275) ...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.