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: README.md
+20-9Lines changed: 20 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,8 +26,6 @@
26
26
27
27
**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/).
28
28
29
-
This project is licensed under the [GNU General Public License 2.0](https://github.com/PREP-NexT/DOMINO-SEE/blob/main/LICENSE).
30
-
31
29
## Why the Name?
32
30
33
31
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
37
35
-**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
38
36
-**Multi-dimensional Support**: Native support for `xarray` DataArrays to handle multi-dimensional gridded climate data
39
37
-**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`).
41
38
-**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`). -->
42
40
43
41
<!-- ## Development Status
44
42
45
43
This project is under active development. Current implementation status:
46
44
47
-
- ✅ **FeketeGrid**: Equidistant grid on a sphere - fully implemented and tested-->
45
+
- ✅ **FeketeGrid**: Equidistant grid on a sphere - fully implemented and tested
48
46
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.-->
50
48
51
49
## Getting Started
52
50
@@ -76,7 +74,18 @@ This section includes a brief tutorial on running your first DOMINO-SEE model.
@@ -94,10 +103,12 @@ If you use DOMINO-SEE in a scientific publication, we would appreciate citations
94
103
95
104
## Contact Us
96
105
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).
98
109
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 forpublic discussionin Issues, please feel free to contact [***Hui-Min Wang***](mailto:wanghuimin@u.nus.edu).
100
111
101
112
## Disclaimer
102
113
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 forrisk assessment and management. The developers will not be held liable for any decisions made based on the use of this model. We recommend applying itin conjunction with expert judgment and other modeling tools in a decision-making context.
-[ ] Define terminology and conventions: Map network terminology to proper xarray terminology
8
8
-[ ] Support unsymmetric event synchronizations (ES)
9
9
-[ ] Add regional bundle analysis
10
10
-[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
15
15
-[ ] Add regrid utilities for remapping to Fekete grid
16
16
-[ ] Introduce `xclim` for time period subsetting (specific months/days)
17
17
-[ ] 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`
18
19
19
20
## Long-term Vision
20
21
@@ -31,6 +32,7 @@ This document outlines the planned future development for the DOMINO-SEE package
0 commit comments