You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/how-to/data-pipeline.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,29 @@
1
-
# Open Climate Risk data pipeline
1
+
# Data pipeline
2
2
3
3
The Open Climate Risk (OCR) data pipeline processes climate risk data through a series of coordinated stages, from individual region processing to final tile generation for visualization.
4
4
5
5
## Overview
6
6
7
7
The pipeline transforms raw climate data into risk assessments through four main stages:
8
8
9
-
1.**Region Processing** - Calculate risk metrics for individual geographic regions
10
-
2.**Data Aggregation** - Combine regional results into consolidated datasets
11
-
3.**Statistical Summaries** - Generate county and tract-level statistics (optional)
12
-
4.**Tile Generation** - Create PMTiles for web visualization
9
+
1.**Region processing** - Calculate risk metrics for individual geographic regions
10
+
2.**Data aggregation** - Combine regional results into consolidated datasets
11
+
3.**Statistical summaries** - Generate county and tract-level statistics (optional)
12
+
4.**Tile generation** - Create PMTiles for web visualization
13
13
14
-
## Getting Started
14
+
## Getting started
15
15
16
16
### Prerequisites
17
17
18
-
- Python environment with OCR package installed (see [installation guide](../how-to/installation.md))
18
+
- Python environment with OCR package installed (see [Installation guide](../how-to/installation.md))
19
19
- AWS credentials (for data access)
20
20
- Coiled account (for cloud execution, optional)
21
21
22
22
### Tutorial: quick end-to-end (local)
23
23
24
24
This tutorial walks you through a short, practical run that processes one region locally and inspects the output.
25
25
26
-
1. Ensure your environment is configured and the package is installed (see [installation guide](../how-to/installation.md)).
26
+
1. Ensure your environment is configured and the package is installed (see [Installation guide](../how-to/installation.md)).
27
27
1. Copy an example env and set a local storage path for quick testing:
Copy file name to clipboardExpand all lines: docs/how-to/getting-started.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,21 +11,21 @@ This guide helps you get started with accessing and using Open Climate Risk fire
11
11
-**Multiple output formats**: Interactive web maps, downloadable datasets, and cloud-native data access
12
12
-**Present and future scenarios**: Current conditions (circa 2011) and future projections (circa 2047)
13
13
14
-
## Quick Access Options
14
+
## Quick access options
15
15
16
-
### Option 1: Explore the Web Tool
16
+
### Option 1: explore the web tool
17
17
18
18
The fastest way to explore Open Climate Risk data is through our [interactive web map](https://carbonplan.org/research/climate-risk). The web tool allows you to:
19
19
20
20
- Search for specific addresses or locations
21
21
- View building-level risk scores on a 0-10 scale
22
22
- Explore state, county, census tract, and census block aggregations
23
23
24
-
### Option 2: Access Production Data
24
+
### Option 2: access production data
25
25
26
26
If you want to analyze Open Climate Risk data programmatically, you can access our production datasets directly from cloud storage using Python.
27
27
28
-
## Accessing Production Data
28
+
## Accessing production data
29
29
30
30
Open Climate Risk output data is stored in [Icechunk](https://icechunk.io/), a versioned, cloud-native data format that works seamlessly with `Xarray` and `Zarr`.
31
31
@@ -37,7 +37,7 @@ You'll need Python with a few packages installed:
37
37
python -m pip install xarray icechunk
38
38
```
39
39
40
-
### Load the Dataset
40
+
### Load the dataset
41
41
42
42
Here's a minimal example to load Open Climate Risk wind-adjusted fire risk data:
@@ -77,41 +77,41 @@ The dataset contains several key variables:
77
77
-**`crps`**: Conditional Risk to Potential Structures (damage if fire occurs)
78
78
- Risk scores are for a "generic" or "potential" structure at each location
79
79
80
-
:::{admonition} **Important Limitation**
80
+
:::{admonition} **Important limitation**
81
81
:class: note
82
82
83
83
Risk scores represent a hypothetical structure and do NOT account for building-specific factors like construction materials, retrofits, or defensible space management.
84
84
:::
85
85
86
-
## Next Steps
86
+
## Next steps
87
87
88
-
### For Data Users
88
+
### For data users
89
89
90
-
-**[Working With Data](work-with-data.ipynb)**: Detailed guide on loading and analyzing Open Climate Risk datasets
91
-
-**[Data Schema](../reference/data-schema.md)**: Complete reference of available variables and metadata
92
-
-**[Access Data](../access-data.md)**: Direct download links and bulk access options
90
+
-**[Working with data](work-with-data.ipynb)**: Detailed guide on loading and analyzing Open Climate Risk datasets
91
+
-**[Data schema](../reference/data-schema.md)**: Complete reference of available variables and metadata
92
+
-**[Access data](../access-data.md)**: Direct download links and bulk access options
93
93
94
-
### For Researchers & Analysts
94
+
### For researchers & analysts
95
95
96
-
-**[Fire Risk Methods Overview](../methods/fire-risk/overview.md)**: Understand how risk scores are calculated
97
-
-**[Data Sources](../reference/data-sources.md)**: Learn about data sources
96
+
-**[Fire risk methods overview](../methods/fire-risk/overview.md)**: Understand how risk scores are calculated
97
+
-**[Data sources](../reference/data-sources.md)**: Learn about data sources
98
98
99
-
### For Developers
99
+
### For developers
100
100
101
101
-**[Installation](installation.md)**: Set up project for local development
102
-
-**[Project Structure](../reference/project-structure.md)**: Understand the codebase
103
-
-**[Data Pipeline](data-pipeline.md)**: Run the processing pipeline
104
-
-**[Working With Input Datasets](work-with-input-datasets.md)**: View technical reference for working with input datasets
102
+
-**[Project structure](../reference/project-structure.md)**: Understand the codebase
103
+
-**[Data pipeline](data-pipeline.md)**: Run the processing pipeline
104
+
-**[Working with input datasets](work-with-input-datasets.md)**: View technical reference for working with input datasets
0 commit comments