Skip to content

Commit 433f0fd

Browse files
committed
Update Readme and Index
1 parent 934058e commit 433f0fd

File tree

3 files changed

+31
-5
lines changed

3 files changed

+31
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,43 @@
11
# Precipitation Index - SPI & SPEI for Climate Extremes Monitoring
22

3+
<img src="./docs/images/logo-white-background.jpg" alt="PRECIP-INDEX Logo" width="200" height="200">
4+
</br>
5+
</br>
6+
37
**precip-index** is a lightweight set of Python scripts for calculating precipitation-based climate indices (SPI and SPEI) and analyzing **dry and wet extremes** using **run theory**, designed for gridded `xarray` workflows.
48

59
📚 Documentation: https://bennyistanto.github.io/precip-index/
610

7-
## Key features
11+
## Key Features
812

9-
- **SPI / SPEI** at 1, 3, 6, 12, 24-month scales (xarray + CF-style NetCDF outputs)
13+
- **SPI / SPEI** at 1, 3, 6, 12, 24-month scales (xarray + CF-compliant NetCDF outputs)
1014
- **Bidirectional extremes**: drought (dry) and flood-prone (wet) conditions in one framework
1115
- **Multi-distribution fitting**: Gamma, Pearson Type III, Log-Logistic
1216
- **Run theory events**: duration, magnitude, intensity, peak, interarrival + gridded summaries
17+
- **Operational mode**: save fitted parameters, load and apply to new data without refitting
1318
- **Scalable processing**: chunked tiling, memory estimation, streaming I/O for global datasets
14-
- **Visualization**: event-highlighted time series, 11-category classification, maps, comparisons
19+
- **Visualization**: event-highlighted time series, 11-category WMO classification, spatial maps
1520

16-
## What makes precip-index different?
21+
## Why precip-index?
1722

1823
- **Dry + wet symmetry**: same API and methodology for negative (drought) and positive (wet) thresholds
1924
- **Distribution-aware SPI/SPEI**: choose the best-fit distribution per workflow (Gamma / P-III / Log-Logistic)
25+
- **Production-ready monitoring**: calibrate once, save parameters, apply consistently to new observations
2026
- **Event analytics included**: run theory metrics beyond simple threshold exceedance
2127
- **Designed for large grids**: practical for CHIRPS / ERA5-Land / TerraClimate via chunked processing
2228

29+
## Global Output
30+
31+
![SPI-12 computed from CHIRPS v3 global (0.05°) — December 2025](./docs/images/global-spi12-202512.png)
32+
33+
SPI-12 (Gamma) calculated from CHIRPS v3 global at 0.05° resolution.
34+
2335
## Credits
2436

25-
SPI/SPEI components are modified/adapted from `climate-indices` by James Adams ([monocongo](https://github.com/monocongo/climate_indices)).
37+
**Benny Istanto**, GOST/DEC Data Group, The World Bank
38+
39+
Built upon the foundation of [climate-indices](https://github.com/monocongo/climate_indices) by James Adams, with substantial additions for multi-distribution support, bidirectional event analysis, operational mode (parameter persistence), and scalable processing.
40+
41+
## License
42+
43+
BSD-3-Clause — see [LICENSE](LICENSE) for details.
330 KB
Loading

docs/index.qmd

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,14 @@ WMO 11-category drought/wet classification. CF-compliant NetCDF output. Run theo
166166

167167
---
168168

169+
## Global Output
170+
171+
![SPI-12 computed from CHIRPS v3 global (0.05°) — December 2025](images/global-spi12-202512.png)
172+
173+
SPI-12 (Gamma) calculated from **CHIRPS v3 global** at 0.05° resolution.
174+
175+
---
176+
169177
## Validation Results
170178

171179
All distributions tested against TerraClimate Bali data (1958–2024). Cross-distribution correlation exceeds 0.98. The test suite generates **28 visualizations** including advanced analytics and operational mode validation.

0 commit comments

Comments
 (0)