zhangrenchao commited on
Commit
7f73043
·
verified ·
1 Parent(s): bd6dbd0

Add English model card

Browse files
Files changed (1) hide show
  1. README.md +84 -0
README.md ADDED
@@ -0,0 +1,84 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
+ tags:
6
+ - OneScience
7
+ - Earth Science
8
+ - TWSA
9
+ - GRACE
10
+ - Self-Supervised Assimilation
11
+ - Hydrology
12
+ frameworks: PyTorch
13
+ ---
14
+
15
+ <p align="center"><strong><span style="font-size: 30px;">GRACE-SEDA</span></strong></p>
16
+
17
+ # Model Introduction
18
+
19
+ GRACE-SEDA is a self-supervised data-assimilation model for global high-resolution total-water-storage anomalies.
20
+
21
+ Paper: Global high-resolution total water storage anomalies from self-supervised data assimilation using deep learning algorithms
22
+ https://doi.org/10.1038/s44221-024-00194-w
23
+
24
+ # Model Description
25
+
26
+ The model was proposed by teams including ETH Zurich. It was trained with JPL GRACE, WGHM, GLDAS hydrological variables, and coordinates. A residual encoder-decoder and dual self-supervised constraints support global 0.5-degree TWSA reconstruction, uncertainty estimation, and water-budget analysis.
27
+
28
+ # Use Cases
29
+
30
+ | Use Case | Description |
31
+ | :---: | :--- |
32
+ | TWSA downscaling | Generate high-resolution water-storage anomalies. |
33
+ | Self-supervised assimilation | Balance GRACE aggregates and WGHM structure. |
34
+ | Uncertainty | Use a five-model deep ensemble. |
35
+ | ModelScope/OneCode execution | Validate data, training, inference, hydrology metrics, and visualization. |
36
+ | Multi-GPU training | Start multi-process training through `torchrun`. |
37
+
38
+ # Usage Instructions
39
+
40
+ ```bash
41
+ hf download OneScience-Group/GRACE-SEDA --local-dir ./GRACE-SEDA
42
+ cd GRACE-SEDA
43
+ ```
44
+
45
+ ### Environment Dependencies
46
+
47
+ **Hardware Requirements**
48
+
49
+ - A GPU or DCU is recommended.
50
+ - A CPU can be used for connectivity validation with the default small-sample configuration.
51
+ - DCU users should install DTK 25.04.2 or a compatible OneScience-recommended version first.
52
+
53
+ **DCU Environment**
54
+
55
+ ```bash
56
+ # Activate DTK and Conda first
57
+ conda create -n onescience311 python=3.11 -y
58
+ conda activate onescience311
59
+ pip install onescience[earth-dcu] -i http://mirrors.onescience.ai:3141/pypi/simple/ --trusted-host mirrors.onescience.ai
60
+ ```
61
+
62
+ **GPU Environment**
63
+
64
+ ```bash
65
+ # Activate Conda first
66
+ conda create -n onescience311 python=3.11 -y libstdcxx-ng=12 libgcc-ng=12 gcc_linux-64=12 gxx_linux-64=12
67
+ conda activate onescience311
68
+ pip install onescience[earth-gpu] -i http://mirrors.onescience.ai:3141/pypi/simple/ --trusted-host mirrors.onescience.ai
69
+ ```
70
+
71
+ ```bash
72
+ python scripts/fake_data.py
73
+ python scripts/train.py
74
+ torchrun --standalone --nproc_per_node=2 scripts/train.py
75
+ python scripts/inference.py
76
+ python scripts/result.py
77
+ ```
78
+ Training optimizes GRACE aggregate and WGHM structural terms. Inference restores five models and evaluation reports finite correlation, aggregate error, and uncertainty.
79
+ ## Trained Weights
80
+ No weights are bundled under `weight/`. The authors provide core code, trained models, and weights at https://gitlab.ethz.ch/spacegeodesy_public/grace_seda.
81
+ # Citation and License
82
+ This repository is an independent engineering reproduction of the public GRACE-SEDA specifications.
83
+
84
+ The original paper is licensed under CC BY 4.0; official code, model weights, and related data retain their respective terms.