zhangrenchao commited on
Commit
f763018
·
verified ·
1 Parent(s): 00cfe91

Add English model card

Browse files
Files changed (1) hide show
  1. README.md +79 -0
README.md ADDED
@@ -0,0 +1,79 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
+ tags:
6
+ - OneScience
7
+ - Earth Science
8
+ - Precipitation Nowcasting
9
+ - Probabilistic Forecasting
10
+ - Radar
11
+ - STEPS
12
+ frameworks: PyTorch
13
+ ---
14
+
15
+ <p align="center"><strong><span style="font-size: 30px;">pysteps</span></strong></p>
16
+
17
+ # Model Introduction
18
+
19
+ pysteps is an open-source framework for probabilistic precipitation nowcasting. This reproduction focuses on optical flow, cascade decomposition, AR(2), and STEPS ensemble generation.
20
+
21
+ Paper: Pysteps: an open-source Python library for probabilistic precipitation nowcasting (v1.0)
22
+ https://doi.org/10.5194/gmd-12-4185-2019
23
+
24
+ # Model Description
25
+
26
+ The method was proposed by teams from the Finnish Meteorological Institute, MeteoSwiss, ETH Zurich, Colorado State University, and collaborators. It estimates motion, cascade, and autoregressive parameters online from five-minute radar sequences collected in several countries. It supports one- to three-hour probabilistic precipitation nowcasting and ensemble uncertainty analysis.
27
+
28
+ # Usage Instructions
29
+
30
+ ```bash
31
+ hf download OneScience-Group/pysteps --local-dir ./pysteps
32
+ cd pysteps
33
+ ```
34
+
35
+ ### Environment Dependencies
36
+
37
+ **Hardware Requirements**
38
+
39
+ - A GPU or DCU is recommended.
40
+ - A CPU can be used for connectivity validation with the default small-sample configuration.
41
+ - DCU users should install DTK 25.04.2 or a compatible OneScience-recommended version first.
42
+
43
+ **DCU Environment**
44
+
45
+ ```bash
46
+ # Activate DTK and Conda first
47
+ conda create -n onescience311 python=3.11 -y
48
+ conda activate onescience311
49
+ pip install onescience[earth-dcu] -i http://mirrors.onescience.ai:3141/pypi/simple/ --trusted-host mirrors.onescience.ai
50
+ ```
51
+
52
+ **GPU Environment**
53
+
54
+ ```bash
55
+ # Activate Conda first
56
+ conda create -n onescience311 python=3.11 -y libstdcxx-ng=12 libgcc-ng=12 gcc_linux-64=12 gxx_linux-64=12
57
+ conda activate onescience311
58
+ pip install onescience[earth-gpu] -i http://mirrors.onescience.ai:3141/pypi/simple/ --trusted-host mirrors.onescience.ai
59
+ ```
60
+
61
+ ```bash
62
+ python scripts/fake_data.py
63
+ python scripts/train.py
64
+ torchrun --standalone --nproc_per_node=2 scripts/train.py
65
+ python scripts/inference.py
66
+ python scripts/result.py
67
+ ```
68
+
69
+ STEPS has no offline gradient training. Inference generates a finite ensemble with shape `[24,12,128,128]`, and evaluation reports RMSE and spread.
70
+
71
+ # Trained Weights
72
+
73
+ No weights are bundled under `weight/`. pysteps estimates parameters online and does not use pretrained neural-network weights; the official software is available at https://github.com/pySTEPS/pysteps.
74
+
75
+ # Citation and License
76
+
77
+ This repository is an independent engineering reproduction of the public pysteps specifications.
78
+
79
+ The original paper is licensed under CC BY 4.0 and the official pysteps software under BSD-3-Clause; the paper, software, and radar data retain their respective terms.