Skip to content

Commit 6fbc34e

Browse files
committed
updated README.md
1 parent 56a6a8f commit 6fbc34e

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ to model the ice thickness of the World's glaciers
1212
#### 1. Setup OGGM
1313
Install [OGGM](https://oggm.org/). ICEBOOST uses OGGM's glacier geometries, v62. They are a slight revision-improvement
1414
of the official, RGI v6 repository, with some additional glaciers added as well.
15-
Once installed, specify its location in the ``` config/config.yaml``` file,
15+
Once installed, specify its location in the ```config/config.yaml``` file,
1616
under the ```oggm_dir``` argument.
1717

1818

@@ -109,7 +109,7 @@ From NSIDC download the ```antarctic_ice_vel_phase_map_v01.nc``` file
109109
and place it in ```Antarctica_NSIDC/velocity/NSIDC-0754/```.
110110

111111

112-
Specify the location of these folders in the ``` config/config.yaml``` file, under the arguments:
112+
Specify the location of these folders in the ```config/config.yaml``` file, under the arguments:
113113
```millan_velocity_dir```, ```NSIDC_velocity_Greenland_dir```, and ```NSIDC_velocity_Antarctica_dir```.
114114

115115
#### 5. Prepare the world's coastlines product
@@ -131,7 +131,7 @@ gdf6 = gpd.read_file('/YOUR_IN_PATH/GSHHS_f_L6.shp', engine='pyogrio')
131131
gdf16 = pd.concat([gdf1, gdf6], ignore_index=True)
132132
gdf16.to_file('/YOUR_OUT_PATH/GSHHS_f_L1_L6.shp', driver='ESRI Shapefile')
133133
```
134-
Place the generated ```GSHHS_f_L1_L6.shp``` file in a folder specified in ``` config/config.yaml``` file,
134+
Place the generated ```GSHHS_f_L1_L6.shp``` file in a folder specified in ```config/config.yaml``` file,
135135
under the argument ```coastlines_gshhg_dir/```.
136136

137137
#### 6. Prepare the RACMO surface mass balance product
@@ -155,7 +155,7 @@ racmo/
155155
├── antarctica_racmo2.3p2/smb_antarctica_mean_1979_2021_RACMO23p2_gf.nc
156156
└── greenland_racmo2.3p2/smb_greenland_mean_1961_1990_RACMO23p2_gf.nc
157157
```
158-
In ``` config/config.yaml``` file, specify the location of the racmo root folder under the argument ```racmo_dir/```.
158+
In ```config/config.yaml``` file, specify the location of the racmo root folder under the argument ```racmo_dir/```.
159159

160160
#### 7. Prepare all other models' ice thickness solutions for comparisons
161161
ICEBOOST code uses the following products of ice thickness distributions for comparisons:
@@ -173,7 +173,7 @@ From NSIDC download ```BedMachineAntarctica-v3.nc``` and place it in ```Antarcti
173173
From [Farinotti et al. (2019)](https://www.research-collection.ethz.ch/handle/20.500.11850/315707), download
174174
the ```composite_thickness_RGI60-all_regions.zip``` archive and extract its content in a folder ```Farinotti/```.
175175

176-
Finally, in ``` config/config.yaml```, specify the locations of the following folders: ```millan_icethickness_dir```,
176+
Finally, in ```config/config.yaml```, specify the locations of the following folders: ```millan_icethickness_dir```,
177177
```NSIDC_icethickness_Greenland_dir```, ```NSIDC_icethickness_Antarctica_dir```, ```farinotti_icethickness_dir```.
178178

179179
#### 8. Prepare ground truth dataset
@@ -217,11 +217,18 @@ The code also contains a module to perform inference on a glacier, by specifying
217217
## Model inference 🔮
218218

219219
---
220+
If you don't want to train the model but just run it, you can get the trained modules (```.json``` and ```.cbm```) from [Zenodo](https://zenodo.org/records/13145836),
221+
specify their names and location in the ```config/config.yaml```, under ```model_input_dir/```, ```model_filename_xgb```,
222+
```model_filename_cat```
223+
and run:
220224
```
221225
python iceboost_deploy.py
222226
```
223-
This piece of code loads the two trained modules and performs model deploy on either one single glacier,
224-
a list of glaciers, or a regional simulation of all glaciers.
227+
The code loads the two trained modules and performs model deploy on either one single glacier,
228+
a list of glaciers, or on all glaciers regionally. Under the hood, the code runs ```fetch_glacier_metadata.py```, which
229+
generates the array features on-the-fly.
230+
231+
In ```config/config.yaml``` you can also specify the number of points you want to generate: ```generate n_points_regression```.
225232

226233
## Acknowledgments
227234

0 commit comments

Comments
 (0)