Skip to content

Commit 831a9cd

Browse files
Docs edit (#358)
* copy edit pass to docs * nit * revert access-data link removal * revert horizontal-scaling-via-spatial-chunking.ipynb
1 parent d1be869 commit 831a9cd

3 files changed

Lines changed: 31 additions & 31 deletions

File tree

docs/access-data.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ There a few different ways to access the data, in addition to exploration via th
1919
| Option | Description | Formats | Access | License | Data sources |
2020
| --------------------------------- | --------------------------------------------------------------------------------------- | --------------------- | ------------------------------------------------------------ | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2121
| **Raster (tensor) data** | Full gridded dataset spanning CONUS | Icechunk (Zarr-based) | [Source Coop](https://source.coop/carbonplan/carbonplan-ocr) | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) | [K Riley et al. 2025](https://doi.org/10.2737/RDS-2025-0006), [J Scott et al. 2024](https://doi.org/10.2737/RDS-2020-0016-2), [R Rasmussen et al. 2023](https://doi.org/10.1175/BAMS-D-21-0326.1) |
22-
| **Vector (polygon) data** | Full buildings dataset spanning CONUS | GeoParquet | [Source Coop](https://source.coop/carbonplan/carbonplan-ocr) | [ODbL](https://opendatacommons.org/licenses/odbl/1-0/) | [Overture Maps Foundation buildings dataset](https://docs.overturemaps.org/guides/buildings/), [K Riley et al. 2025](https://doi.org/10.2737/RDS-2025-0006), [J Scott et al. 2024](https://doi.org/10.2737/RDS-2020-0016-2), [R Rasmussen et al. 2023](https://doi.org/10.1175/BAMS-D-21-0326.1) |
22+
| **Vector (polygon) data** | Full buildings dataset spanning CONUS | GeoParquet | [Source Coop](https://source.coop/carbonplan/carbonplan-ocr) | [ODbL](https://opendatacommons.org/licenses/odbl/1-0/) | [Overture Maps Foundation buildings dataset](https://docs.overturemaps.org/guides/buildings/), [K Riley et al. 2025](https://doi.org/10.2737/RDS-2025-0006), [J Scott et al. 2024](https://doi.org/10.2737/RDS-2020-0016-2), [R Rasmussen et al. 2023](https://doi.org/10.1175/BAMS-D-21-0326.1) |
2323
| **Regional statistics** | Summary statistics for regions (state, county, census tract, census block) within CONUS | CSV, GeoJSON | [Source Coop](https://source.coop/carbonplan/carbonplan-ocr) | [ODbL](https://opendatacommons.org/licenses/odbl/1-0/) | [Census TIGER/Line](https://www.census.gov/geographies/mapping-files/time-series/geo/tiger-line-file.html), [Overture Maps Foundation buildings dataset](https://docs.overturemaps.org/guides/buildings/), [K Riley et al. 2025](https://doi.org/10.2737/RDS-2025-0006), [J Scott et al. 2024](https://doi.org/10.2737/RDS-2020-0016-2), [R Rasmussen et al. 2023](https://doi.org/10.1175/BAMS-D-21-0326.1) |
2424
| **Subsetted vector (point) data** | Building-level data subsetted to active region (county, census tract, census block) | CSV, GeoPackage | Web tool (see below) | [ODbL](https://opendatacommons.org/licenses/odbl/1-0/) | [Census TIGER/Line](https://www.census.gov/geographies/mapping-files/time-series/geo/tiger-line-file.html), [Overture Maps Foundation buildings dataset](https://docs.overturemaps.org/guides/buildings/), [K Riley et al. 2025](https://doi.org/10.2737/RDS-2025-0006), [J Scott et al. 2024](https://doi.org/10.2737/RDS-2020-0016-2), [R Rasmussen et al. 2023](https://doi.org/10.1175/BAMS-D-21-0326.1) |
2525

2626
## Full dataset downloads
2727

2828
### Links
2929

30-
| Option | Path | Notes |
31-
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
32-
| **Raster (tensor) data** | `s3://us-west-2.opendata.source.coop/carbonplan/carbonplan-ocr/output/fire-risk/tensor/production/v1.0.0/ocr.icechunk/` | See [guide for working with Icehunk data](./how-to/work-with-data.ipynb) |
33-
| **Vector (polygon) data** | `s3://us-west-2.opendata.source.coop/carbonplan/carbonplan-ocr/output/fire-risk/vector/production/v1.0.0/geoparquet/buildings.parquet` | See [guide for working with GeoParquet data](./how-to/work-with-data.ipynb) |
30+
| Option | Path | Notes |
31+
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
32+
| **Raster (tensor) data** | `s3://us-west-2.opendata.source.coop/carbonplan/carbonplan-ocr/output/fire-risk/tensor/production/v1.0.0/ocr.icechunk/` | See [guide for working with Icehunk data](./how-to/work-with-data.ipynb) |
33+
| **Vector (polygon) data** | `s3://us-west-2.opendata.source.coop/carbonplan/carbonplan-ocr/output/fire-risk/vector/production/v1.0.0/geoparquet/buildings.parquet` | See [guide for working with GeoParquet data](./how-to/work-with-data.ipynb) |
3434

3535
### Schema
3636

@@ -62,7 +62,7 @@ The schemas for each of the full datasets are described on the [data schema](./r
6262
| `rps_2047_mean` | float | Mean annual fire risk (~2047 climate conditions) across all buildings in region |
6363
| `bp_2011_mean` | float | Mean burn probability (~2011 climate conditions) across all buildings in region |
6464
| `bp_2047_mean` | float | Mean burn probability (~2047 climate conditions) across all buildings in region |
65-
| `crps_scott_mean` | float | Mean conditional risk to potential structures (cRPS) from Scott et al., (2024) |
65+
| `crps_scott_mean` | float | Mean conditional risk to potential structures (cRPS) from Scott et al., (2024) |
6666
| `bp_2011_riley_mean` | float | Mean burn probability (~2011 climate conditions) across all buildings in region from Riley et al., (2025) |
6767
| `bp_2047_riley_mean` | float | Mean burn probability (~2047 climate conditions) across all buildings in region from Riley et al., (2025) |
6868
| `rps_2011_median` | float | Median annual fire risk (~2011 climate conditions) across all buildings in region |

docs/reference/data-schema.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ graph TB
3535
%% Storage Formats
3636
subgraph Storage["<b>Storage Formats</b>"]
3737
Icechunk[("<b>Icechunk</b><br/>Zarr-based<br/>S3-backed<br/>Versioned")]
38-
GeoParquet[("<b>GeoParquet</b><br/>zstd compressed<br/>Consolidated<br/>Single file")]
38+
GeoParquet[("<b>GeoParquet</b><br/>Hive-partitioned")]
3939
end
4040
4141
%% Data Flow
@@ -123,8 +123,8 @@ The `wind_direction` coordinate contains 8 direction labels: `['N', 'NE', 'E', '
123123

124124
**Properties:**
125125

126-
- Values sum to 1.0 for all pixels (normalized probability distribution)
127-
- Derived from CONUS404 data (Rasmussen et al, 2023) using 99th percentile Fosberg Fire Weather Index (FFWI) as threshold
126+
- Values sum to 1.0 for all pixels (normalized probability distribution)
127+
- Derived from CONUS404 data (Rasmussen et al, 2023) using 99th percentile Fosberg Fire Weather Index (FFWI) as threshold
128128

129129
### Data Processing Flow
130130

@@ -178,8 +178,8 @@ Vector datasets contain building-level risk samples stored as a consolidated Geo
178178

179179
#### Geometry Column
180180

181-
| Column | Type | Description |
182-
| ---------- | ----------- | --------------------------------------- |
181+
| Column | Type | Description |
182+
| ---------- | ------------- | -------------------------------------- |
183183
| `geometry` | WKB (Polygon) | Building polygon location in EPSG:4326 |
184184

185185
#### Risk Attribute Columns
@@ -210,8 +210,8 @@ Vector datasets contain the same risk variables as raster datasets, sampled at e
210210

211211
### Data Quality
212212

213-
- Buildings with NaN values (outside CONUS) are excluded
214-
- Building locations sourced from Overture Maps dataset
213+
- Buildings with NaN values (outside CONUS) are excluded
214+
- Building locations sourced from Overture Maps dataset
215215

216216
### File Location
217217

@@ -223,9 +223,9 @@ The consolidated building dataset is available at:
223223

224224
This single-file format enables:
225225

226-
- Efficient CONUS-wide spatial queries
227-
- Direct access for analysis tools and workflows
228-
- Simplified data distribution and versioning
226+
- Efficient CONUS-wide spatial queries
227+
- Direct access for analysis tools and workflows
228+
- Simplified data distribution and versioning
229229

230230
## Data Validation
231231

@@ -249,28 +249,28 @@ This single-file format enables:
249249

250250
All datasets include descriptive metadata attributes:
251251

252-
- `description`: Human-readable description of the variable
253-
- `long_name`: Extended variable name
254-
- `units`: Physical units (if applicable)
255-
- `composition`: Method used for compositing (e.g., "weighted")
256-
- `direction_labels`: Cardinal/ordinal direction labels for wind data
257-
- `weights_source`: Source of weights used in calculations
252+
- `description`: Human-readable description of the variable
253+
- `long_name`: Extended variable name
254+
- `units`: Physical units (if applicable)
255+
- `composition`: Method used for compositing (e.g., "weighted")
256+
- `direction_labels`: Cardinal/ordinal direction labels for wind data
257+
- `weights_source`: Source of weights used in calculations
258258

259259
## Access Patterns
260260

261261
### Raster Data
262262

263-
- **By Region**: Query specific regional chunks using latitude/longitude slices
264-
- **Full CONUS**: Access complete dataset via Icechunk storage
263+
- **By Region**: Query specific regional chunks using latitude/longitude slices
264+
- **Full CONUS**: Access complete dataset via Icechunk storage
265265

266266
### Vector Data
267267

268-
- **Full Dataset**: Query the consolidated CONUS-wide building dataset
269-
- **Spatial Query**: Use bounding box attributes for efficient spatial filtering
270-
- **Attribute Query**: Filter by risk threshold using Parquet predicate pushdown with DuckDB or similar tools
271-
- **Regional Subset**: Extract specific areas using spatial predicates on latitude/longitude
268+
- **Full Dataset**: Query the consolidated CONUS-wide building dataset
269+
- **Spatial Query**: Use bounding box attributes for efficient spatial filtering
270+
- **Attribute Query**: Filter by risk threshold using Parquet predicate pushdown with DuckDB or similar tools
271+
- **Regional Subset**: Extract specific areas using spatial predicates on latitude/longitude
272272

273273
## Related Documentation
274274

275-
- [Data Downloads](../access-data.md): Information on accessing and downloading datasets
276-
- [Deployment](deployment.md): Details on data storage infrastructure
275+
- [Data Downloads](../access-data.md): Information on accessing and downloading datasets
276+
- [Deployment](deployment.md): Details on data storage infrastructure

docs/terms-of-data-access.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## License Agreement
22

3-
Open Climate Risk data are made available under the licenses listed on the [Access Data](access-data.md#download-options) page. By accessing the data, you agree to adhere to the license terms.
3+
Open Climate Risk data are made available under the licenses listed on the [Access Data](access-data.md) page. By accessing the data, you agree to adhere to the license terms.
44

55
## Our Terms of Use Apply To Open Climate Risk
66

0 commit comments

Comments
 (0)