Skip to content

Commit

Permalink
Get ready for release (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
fmaussion authored Aug 22, 2024
1 parent 0a2f64c commit de11c9c
Show file tree
Hide file tree
Showing 10 changed files with 519 additions and 52 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ out.*
RGI60-*
sandbox/
outputs
ignore/

# Mac
.DS_Store
Expand Down
8 changes: 5 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,21 @@ html:
use_repository_button: true
use_issues_button: true
use_edit_page_button: true
google_analytics_id: UA-106829797-2
extra_footer: |
<p>
These notebooks are licensed under a <a href="https://github.com/OGGM/tutorials/blob/master/LICENSE.txt" target="_blank">BSD-3-Clause license</a>.
<br>
&copy; Copyright 2014-2021.
&copy; Copyright 2014-2024.
</p>
sphinx:
config:
html_show_copyright: false
html_last_updated_fmt: '%b %d, %Y'
nb_merge_streams: true
html_js_files:
- ['https://plausible.oggm.org/js/script.js', {'defer': 'defer', 'data-domain': 'tutorials.oggm.org'}]
execute:
execute_notebooks: auto # off (for tests)
timeout: -1
allow_errors: true
exclude_patterns: [.virtual_documents/*,README.md,sandbox/*]
exclude_patterns: [.virtual_documents/*,README.md,sandbox/*,ignore/*]
2 changes: 1 addition & 1 deletion notebooks/10minutes/dynamical_spinup.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.4"
"version": "3.12.4"
},
"latex_envs": {
"LaTeX_envs_menu_present": true,
Expand Down
2 changes: 1 addition & 1 deletion notebooks/10minutes/machine_learning.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1039,7 +1039,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.4"
"version": "3.12.4"
},
"toc": {
"base_numbering": 1,
Expand Down
13 changes: 7 additions & 6 deletions notebooks/10minutes/preprocessed_directories.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@
},
"outputs": [],
"source": [
"rgi_ids = ['RGI60-11.01328', 'RGI60-11.00897'] "
"rgi_ids = ['RGI60-11.01328', 'RGI60-11.01450'] "
]
},
{
Expand All @@ -189,9 +189,10 @@
"source": [
"You can provide any number of glacier identifiers to OGGM. In this case, we chose: \n",
"- `RGI60-11.01328`: [Unteraar Glacier](https://en.wikipedia.org/wiki/Unteraargletscher) in the Swiss Alps\n",
"- `RGI60-11.00897`: [Hintereisferner](http://acinn.uibk.ac.at/research/ice-and-climate/projects/hintereisferner) in the Austrian Alps.\n",
"- `RGI60-11.01450`: [Aletsch Glacier](https://en.wikipedia.org/wiki/Aletsch_Glacier) in the Swiss Alps\n",
"\n",
"Here is a list of other glaciers you might want to try out:\n",
"- `RGI60-11.00897`: [Hintereisferner](http://acinn.uibk.ac.at/research/ice-and-climate/projects/hintereisferner) in the Austrian Alps.\n",
"- `RGI60-18.02342`: [Tasman Glacier](https://en.wikipedia.org/wiki/Tasman_Glacier) in New Zealand\n",
"- `RGI60-11.00787`: [Kesselwandferner](https://de.wikipedia.org/wiki/Kesselwandferner) in the Austrian Alps\n",
"- ... or any other glacier identifier! You can find other glacier identifiers by exploring the [GLIMS viewer](https://www.glims.org/maps/glims).\n",
Expand Down Expand Up @@ -257,7 +258,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"- the keyword `from_prepro_level` indicates that we will start from [pre-processed directories](https://docs.oggm.org/en/stable/shop.html#pre-processed-directories), i.e. data that are already prepared by the OGGM team. In many cases you will want to start from pre-processed directories, in most case from level 3 or 5. For level 3 and above the model has already been calibrated, so you no longer need to do that yourself and can start rigth away with your simulation. Here we start from level 4 and add some data to the processing in order to demonstrate the OGGM workflow.\n",
"- the keyword `from_prepro_level` indicates that we will start from [pre-processed directories](https://docs.oggm.org/en/stable/shop.html#pre-processed-directories), i.e. data that are already prepared by the OGGM team. In many cases you will want to start from pre-processed directories, in most cases from level 3 or 5. For level 3 and above the model has already been calibrated, so you no longer need to do that yourself and can start rigth away with your simulation. Here we start from level 4 and add some data to the processing in order to demonstrate the OGGM workflow.\n",
"- the `prepro_border` keyword indicates the number of grid points which we'd like to add to each side of the glacier for the local map: the larger the glacier will grow, the larger the border parameter should be. The available pre-processed border values are: **10, 80, 160, 240** (depending on the model set-ups there might be more or less options). These are the fixed map sizes we prepared for you - any other map size will require a full processing (see the [further DEM sources example](../tutorials/dem_sources.ipynb) for a tutorial)."
]
},
Expand Down Expand Up @@ -418,8 +419,8 @@
"with xr.open_dataset(gdir.get_filepath('climate_historical')) as ds:\n",
" ds = ds.load()\n",
"# Plot the data\n",
"ds.temp.resample(time='AS').mean().plot(label=f'Annual temperature at {int(ds.ref_hgt)}m a.s.l.');\n",
"ds.temp.resample(time='AS').mean().rolling(time=31, center=True, min_periods=15).mean().plot(label='30yr average');\n",
"ds.temp.resample(time='YS').mean().plot(label=f'Annual temperature at {int(ds.ref_hgt)}m a.s.l.');\n",
"ds.temp.resample(time='YS').mean().rolling(time=31, center=True, min_periods=15).mean().plot(label='30yr average');\n",
"plt.legend();"
]
},
Expand Down Expand Up @@ -560,7 +561,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.4"
"version": "3.12.4"
},
"latex_envs": {
"LaTeX_envs_menu_present": true,
Expand Down
2 changes: 1 addition & 1 deletion notebooks/10minutes/run_with_gcm.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.4"
"version": "3.12.4"
},
"latex_envs": {
"LaTeX_envs_menu_present": true,
Expand Down
8 changes: 5 additions & 3 deletions notebooks/construction/inversion_with_frontal_ablation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Ice thickness inversion with frontal ablation: a case study"
"# Ice thickness inversion with frontal ablation"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"This notebook has been temporarily removed from the tutorials, as we are working on a better version! Check our progress [here]()."
"This notebook has been temporarily removed from the tutorials.\n",
"\n",
"The notebook worked with OGGM v1.5.3: "
]
},
{
Expand Down Expand Up @@ -43,7 +45,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.9"
"version": "3.11.4"
},
"latex_envs": {
"LaTeX_envs_menu_present": true,
Expand Down
Loading

0 comments on commit de11c9c

Please sign in to comment.