Skip to content

Commit 1e3879f

Browse files
authored
Docs copy cleanup pass (#369)
* Update landing page * Data access updates * Make key copy edits * More consistent cross-page references * More consistent sentence-casing * Capitalize terms page, consistent with OffsetsDB * Fix broken admonition * Update disclaimer text
1 parent dd90708 commit 1e3879f

22 files changed

+265
-259
lines changed

docs/access-data.md

Lines changed: 20 additions & 20 deletions
Large diffs are not rendered by default.

docs/how-to/data-pipeline.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
# Open Climate Risk data pipeline
1+
# Data pipeline
22

33
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.
44

55
## Overview
66

77
The pipeline transforms raw climate data into risk assessments through four main stages:
88

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
1313

14-
## Getting Started
14+
## Getting started
1515

1616
### Prerequisites
1717

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))
1919
- AWS credentials (for data access)
2020
- Coiled account (for cloud execution, optional)
2121

2222
### Tutorial: quick end-to-end (local)
2323

2424
This tutorial walks you through a short, practical run that processes one region locally and inspects the output.
2525

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)).
2727
1. Copy an example env and set a local storage path for quick testing:
2828

2929
```bash
@@ -58,7 +58,7 @@ ocr run --region-id y10_x2 --region-id y11_x3 --platform coiled --env-file .env
5858

5959
1. Monitor the job on Coiled's web UI and check outputs in your `OCR_STORAGE_ROOT` bucket.
6060

61-
### Basic Usage
61+
### Basic usage
6262

6363
Process a single region locally:
6464

@@ -78,9 +78,9 @@ Process all available regions:
7878
ocr run --all-region-ids --platform coiled
7979
```
8080

81-
## Execution Platforms
81+
## Execution platforms
8282

83-
### Local Platform
83+
### Local platform
8484

8585
**Best for:** Development, testing, debugging, small datasets
8686

@@ -90,7 +90,7 @@ ocr run --all-region-ids --platform coiled
9090
- Limited by local computational resources
9191
- Sequential processing only
9292

93-
### Coiled Platform
93+
### Coiled platform
9494

9595
**Best for:** Production workloads, large-scale processing, parallel execution
9696

@@ -102,7 +102,7 @@ ocr run --all-region-ids --platform coiled
102102

103103
## Configuration
104104

105-
### Environment Setup
105+
### Environment setup
106106

107107
Create a `.env` file for your configuration:
108108

@@ -120,16 +120,16 @@ Use your configuration file:
120120
ocr run --env-file .env --region-id y10_x2
121121
```
122122

123-
### Key Configuration Components
123+
### Key configuration components
124124

125-
- **Icechunk Store** - Version-controlled data storage backend
126-
- **Vector Output** - Location for processed geoparquet and PMTiles files
125+
- **Icechunk store** - Version-controlled data storage backend
126+
- **Vector output** - Location for processed geoparquet and PMTiles files
127127
- **Environment** - Data version/environment (prod, QA, etc.)
128128
- **Chunking** - Defines valid region boundaries and IDs
129129

130-
## CLI Commands
130+
## CLI commands
131131

132-
For detailed CLI documentation, see the [API Reference](../reference/api.md#cli-application).
132+
For detailed CLI documentation, see the [API reference](../reference/api.md#cli-application).
133133

134134
```bash
135135
# View all available commands
@@ -140,13 +140,13 @@ ocr run --help
140140
ocr aggregate-regional-stats --help
141141
```
142142

143-
### Pipeline Orchestration
143+
### Pipeline orchestration
144144

145-
#### `ocr run` - Full Pipeline
145+
#### `ocr run` - full pipeline
146146

147147
The main command that orchestrates the complete processing pipeline.
148148

149-
**Key Options:**
149+
**Key options:**
150150

151151
- `--region-id` - Process specific regions (can specify multiple)
152152
- `--all-region-ids` - Process all available regions
@@ -168,9 +168,9 @@ ocr run --region-id y10_x2 --region-id y11_x3 --risk-type wind --platform coiled
168168

169169
```
170170

171-
### Individual Stage Commands
171+
### Individual stage commands
172172

173-
#### `ocr process-region` - Single Region Processing
173+
#### `ocr process-region` - single region processing
174174

175175
Process risk calculations for one specific region.
176176

@@ -182,23 +182,23 @@ ocr process-region y10_x2 --risk-type fire
182182
ocr process-region y15_x7 --env-file production.env --risk-type wind
183183
```
184184

185-
#### `ocr partition-buildings` - Data Consolidation
185+
#### `ocr partition-buildings` - data consolidation
186186

187187
Partition processed geoparquet files by state and county FIPS codes.
188188

189189
```bash
190190
ocr partition-buildings --env-file .env
191191
```
192192

193-
#### `ocr aggregate-region-risk-summary-stats` - Statistical Summaries
193+
#### `ocr aggregate-region-risk-summary-stats` - statistical summaries
194194

195195
Generate county and tract-level risk statistics.
196196

197197
```bash
198198
ocr aggregate-region-risk-summary-stats --env-file .env
199199
```
200200

201-
#### `ocr create-regional-pmtiles` - Regional Tiles
201+
#### `ocr create-regional-pmtiles` - regional tiles
202202

203203
Create PMTiles for county and tract-level visualizations.
204204

@@ -214,7 +214,7 @@ Generate PMTiles from the consolidated building dataset.
214214
ocr create-building-pmtiles --env-file .env
215215
```
216216

217-
#### `ocr write-aggregated-region-analysis-files` - Write Analysis Files
217+
#### `ocr write-aggregated-region-analysis-files` - write analysis files
218218

219219
Write aggregated region analysis files (csv, geoparquet and geojson).
220220
You can add the flag `--write-region-files` to `ocr run` to add this optional step in the pipeline.
@@ -225,7 +225,7 @@ ocr write-aggregated-region-analysis-files --env-file .env
225225

226226
## Troubleshooting
227227

228-
### Common Issues
228+
### Common issues
229229

230230
### Environment configuration issues
231231

@@ -241,13 +241,13 @@ Error: Missing required environment variables
241241

242242
### Resource and access issues
243243

244-
#### Local Platform
244+
#### Local platform
245245

246246
- **Disk space:** Check available space in temp directory
247247
- **Memory:** Reduce dataset size or increase system RAM
248248
- **Permissions:** Verify file/directory access rights
249249

250-
#### Coiled Platform
250+
#### Coiled platform
251251

252252
- **Job failures:** Check Coiled credentials and account quotas
253253
- **AWS access:** Verify IAM permissions and credentials

docs/how-to/getting-started.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ This guide helps you get started with accessing and using Open Climate Risk fire
1111
- **Multiple output formats**: Interactive web maps, downloadable datasets, and cloud-native data access
1212
- **Present and future scenarios**: Current conditions (circa 2011) and future projections (circa 2047)
1313

14-
## Quick Access Options
14+
## Quick access options
1515

16-
### Option 1: Explore the Web Tool
16+
### Option 1: explore the web tool
1717

1818
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:
1919

2020
- Search for specific addresses or locations
2121
- View building-level risk scores on a 0-10 scale
2222
- Explore state, county, census tract, and census block aggregations
2323

24-
### Option 2: Access Production Data
24+
### Option 2: access production data
2525

2626
If you want to analyze Open Climate Risk data programmatically, you can access our production datasets directly from cloud storage using Python.
2727

28-
## Accessing Production Data
28+
## Accessing production data
2929

3030
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`.
3131

@@ -37,7 +37,7 @@ You'll need Python with a few packages installed:
3737
python -m pip install xarray icechunk
3838
```
3939

40-
### Load the Dataset
40+
### Load the dataset
4141

4242
Here's a minimal example to load Open Climate Risk wind-adjusted fire risk data:
4343

@@ -68,7 +68,7 @@ This gives you access to:
6868
- **Spatial coverage**: Full CONUS extent
6969
- **Multiple variables**: Burn probability, conditional risk, wind-adjusted metrics
7070

71-
### Understanding the Data
71+
### Understanding the data
7272

7373
The dataset contains several key variables:
7474

@@ -77,41 +77,41 @@ The dataset contains several key variables:
7777
- **`crps`**: Conditional Risk to Potential Structures (damage if fire occurs)
7878
- Risk scores are for a "generic" or "potential" structure at each location
7979

80-
:::{admonition} **Important Limitation**
80+
:::{admonition} **Important limitation**
8181
:class: note
8282

8383
Risk scores represent a hypothetical structure and do NOT account for building-specific factors like construction materials, retrofits, or defensible space management.
8484
:::
8585

86-
## Next Steps
86+
## Next steps
8787

88-
### For Data Users
88+
### For data users
8989

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
9393

94-
### For Researchers & Analysts
94+
### For researchers & analysts
9595

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
9898

99-
### For Developers
99+
### For developers
100100

101101
- **[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
105105

106106
## Support
107107

108108
- **Issues & Bug Reports**: [GitHub Issues](https://github.com/carbonplan/ocr/issues)
109109
- **Questions & Discussions**: [GitHub Discussions](https://github.com/carbonplan/ocr/discussions)
110110
- **General Inquiries**: [hello@carbonplan.org](mailto:hello@carbonplan.org)
111111

112-
## Available Data Versions
112+
## Available data versions
113113

114-
Check our [GitHub Releases](https://github.com/carbonplan/ocr/releases) page for:
114+
Check our [GitHub releases](https://github.com/carbonplan/ocr/releases) page for:
115115

116116
- Latest data version numbers
117117
- Release notes and changelogs
@@ -120,4 +120,4 @@ Check our [GitHub Releases](https://github.com/carbonplan/ocr/releases) page for
120120

121121
---
122122

123-
_Ready to dive deeper? Check out the [Working With Data](work-with-data.ipynb) notebook for hands-on examples._
123+
_Ready to dive deeper? Check out the [Working with data](work-with-data.ipynb) notebook for hands-on examples._

0 commit comments

Comments
 (0)