Skip to content

Commit f651efb

Browse files
committed
docs: update README with APA-style citation
1 parent d09aab8 commit f651efb

3 files changed

Lines changed: 26 additions & 12 deletions

File tree

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@
2626

2727
**DOMINO-SEE** (**D**etection Of **M**ulti-layer **IN**terconnected **O**ccurrences for **S**patial **E**xtreme **E**vents) is a data-driven statistical framework for detecting spatially co-occurrences of hydroclimatic extreme events across locations, inspired by complex network science, powered by `xarray` architecture. It's developed by [Hui-Min Wang](https://orcid.org/0000-0002-5878-7542) and [Xiaogang He](https://cde.nus.edu.sg/cee/staff/he-xiaogang/) from the [PREP-NexT](https://github.com/PREP-NexT) Lab at the [National University of Singapore](https://nus.edu.sg/).
2828

29-
This project is licensed under the [GNU General Public License 2.0](https://github.com/PREP-NexT/DOMINO-SEE/blob/main/LICENSE).
30-
3129
## Why the Name?
3230

3331
The name **DOMINO-SEE** represents our approach to detecting and analyzing interconnected occurrences of hydroclimatic extreme events across spatial locations, inspired by the cascade effect of **DOMINO**es falling in a chain reaction. The **SEE** highlights the framework's ability to capture the spatial synchronization and propagation of extreme events, emphasizing the interconnectedness inherent in complex environmental systems.
@@ -37,16 +35,16 @@ The name **DOMINO-SEE** represents our approach to detecting and analyzing inter
3735
- **Complex Network Generation**: Fast and memory-efficient functions to build spatial networks from event series among spatial locations and multiple types (layers) of climate extreme events
3836
- **Multi-dimensional Support**: Native support for `xarray` DataArrays to handle multi-dimensional gridded climate data
3937
- **Parallel Processing**: `dask` integration for efficient processing of large-scale climate datasets
40-
- **Blockwise Computation**: Utilities for splitting large spatial datasets into manageable blocks of netCDF datasets (see `dominosee/utils/blocking.py`).
4138
- **Grid Generation**: Equidistant Fekete grid generation for alternative spatial embedding.
39+
<!-- - **Blockwise Computation**: Utilities for splitting large spatial datasets into manageable blocks of netCDF datasets (see `dominosee/utils/blocking.py`). -->
4240

4341
<!-- ## Development Status
4442
4543
This project is under active development. Current implementation status:
4644
47-
- ✅ **FeketeGrid**: Equidistant grid on a sphere - fully implemented and tested -->
45+
- ✅ **FeketeGrid**: Equidistant grid on a sphere - fully implemented and tested
4846
49-
The grid module is being uploaded as a work-in-progress to facilitate collaborative development. Only `BaseGrid` and `FeketeGrid` are currently recommended for production use.
47+
The grid module is being uploaded as a work-in-progress to facilitate collaborative development. Only `BaseGrid` and `FeketeGrid` are currently recommended for production use. -->
5048

5149
## Getting Started
5250

@@ -76,7 +74,18 @@ This section includes a brief tutorial on running your first DOMINO-SEE model.
7674

7775
![DOMINO-SEE_logos_QR](https://raw.githubusercontent.com/PREP-NexT/DOMINO-SEE/refs/heads/main/docs/source/_static/images/dominosee_banner_qr_white.svg)
7876

79-
If you use DOMINO-SEE in a scientific publication, we would appreciate citations. You can use the following BibTeX entry:
77+
If you use DOMINO-SEE in a scientific publication, we kindly ask that you cite our article published in Nature Water:
78+
79+
<table>
80+
<tr>
81+
<td>
82+
Wang, H.-M., &amp; He, X. (2025). Spatially synchronized structures of global hydroclimatic extremes.
83+
<em>Nature Water</em>. https://doi.org/10.1038/s44221-025-00520-w
84+
</td>
85+
</tr>
86+
</table>
87+
88+
You may also use the following BibTeX entry:
8089

8190
```bibtex
8291
@article{wang_2025,
@@ -94,10 +103,12 @@ If you use DOMINO-SEE in a scientific publication, we would appreciate citations
94103

95104
## Contact Us
96105

97-
If you have any questions, comments, or suggestions that aren't suitable for public discussion in the Issues section, please feel free to contact [Hui-Min Wang](mailto:wanghuimin@u.nus.edu).
106+
DOMINO-SEE is in active development by [Hui-Min Wang](mailto:wanghuimin@u.nus.edu) in [PREP-NexT Lab](https://github.com/PREP-NexT).
107+
108+
- If you're interested in suggesting new features or reporting bugs, please leave us a message on the [***issue tracker***](https://github.com/PREP-NexT/DOMINO-SEE/issues).
98109
99-
Please use the GitHub Issues for public discussions related to bugs, enhancements, or other project-related discussions.
110+
- If you have any questions, comments, or suggestions that aren't suitable for public discussion in Issues, please feel free to contact [***Hui-Min Wang***](mailto:wanghuimin@u.nus.edu).
100111

101112
## Disclaimer
102113

103-
The DOMINO-SEE model is an academic project and is not intended to be used as a precise prediction tool for risk assessment and management. The developers will not be held liable for any decisions made based on the use of this model. We recommend applying it in conjunction with expert judgment and other modeling tools in a decision-making context.
114+
This project is licensed under the [GNU General Public License 3.0](https://github.com/PREP-NexT/DOMINO-SEE/blob/main/LICENSE). The DOMINO-SEE model is an academic project and is not intended to be used as a precise prediction tool for risk assessment and management. The developers will not be held liable for any decisions made based on the use of this model. We recommend applying it in conjunction with expert judgment and other modeling tools in a decision-making context.

ROADMAP.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document outlines the planned future development for the DOMINO-SEE package
44

55
## Short-term Goals (Next Few Releases)
66

7-
- [ ] Define terminology: Map network terminology to proper xarray terminology
7+
- [ ] Define terminology and conventions: Map network terminology to proper xarray terminology
88
- [ ] Support unsymmetric event synchronizations (ES)
99
- [ ] Add regional bundle analysis
1010
- [x] Add basic tests to examine the correctness of calculations (In progress)
@@ -15,6 +15,7 @@ This document outlines the planned future development for the DOMINO-SEE package
1515
- [ ] Add regrid utilities for remapping to Fekete grid
1616
- [ ] Introduce `xclim` for time period subsetting (specific months/days)
1717
- [ ] Introduce `xclim` for event sub-selection
18+
- [ ] Streamline blockwise computation utilities ( `dominosee/utils/blocking.py`) for splitting large spatial datasets into manageable blocks of netCDF datasets based on `dask`
1819

1920
## Long-term Vision
2021

@@ -31,6 +32,7 @@ This document outlines the planned future development for the DOMINO-SEE package
3132

3233
## Community Features
3334

35+
- [ ] Purge ROADMAP out to GitHub Discussion
3436
- [x] Create contribution guidelines
3537
- [x] Add examples directory with sample scripts
3638

docs/source/changelog.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ Changelog
33

44
This page documents the changes made to DOMINO-SEE in each release.
55

6-
Version 0.0.1 (Development)
6+
Version 0.0.1-alpha (Development)
77
---------------------------
88

99
Initial release of DOMINO-SEE:
1010

11-
* Complex network generation tools for analyzing interconnected hydroclimatic extreme events
11+
* Complex network generation tools for analyzing spatially synchronized hydroclimatic extreme events
12+
* Grid generation tools for the Fekete grid

0 commit comments

Comments
 (0)