Skip to content

Commit

Permalink
ADD: Add intro to open radar science presentation (#104)
Browse files Browse the repository at this point in the history
* ADD: Add intro to open radar science presentation

* tag docker

* changes with respect to toc and navigation

* fix pyrad link

* ADD: Add jupyterlab rise and remove old environment file

---------

Co-authored-by: Kai Mühlbauer <kai.muehlbauer@uni-bonn.de>
Co-authored-by: Kai Mühlbauer <kmuehlbauer@wradlib.org>
  • Loading branch information
3 people authored Sep 5, 2024
1 parent d545003 commit 223991d
Show file tree
Hide file tree
Showing 27 changed files with 706 additions and 76 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-book-pullrequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ permissions:
contents: read

env:
DOCKER_TAG: pr_105
DOCKER_TAG: pr_104

jobs:
build-book:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build-book.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ on:
type: string # had a lot of trouble with boolean types, see https://github.com/actions/runner/issues/1483

env:
DOCKER_TAG: pr_105
DOCKER_TAG: pr_104

jobs:
build-container:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-book.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
uses: ./.github/workflows/build-book.yaml
with:
environment_name: erad-2024-dev
environment_file: environment.yml
environment_file: binder/environment.yml
path_to_notebooks: ./

deploy:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish-book.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ jobs:
uses: ./.github/workflows/build-book.yaml
with:
environment_name: erad-2024-dev
environment_file: environment.yml
environment_file: binder/environment.yml
path_to_notebooks: ./

link-check:
uses: ./.github/workflows/link-checker.yaml
with:
environment_name: erad-2024-dev
environment_file: environment.yml
environment_file: binder/environment.yml
path_to_notebooks: ./
2 changes: 1 addition & 1 deletion binder/Dockerfile
Original file line number Diff line number Diff line change
@@ -1 +1 @@
FROM ghcr.io/openradar/erad2024:pr_105
FROM ghcr.io/openradar/erad2024:pr_104
1 change: 1 addition & 0 deletions binder/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ dependencies:
- rioxarray
# needed for LROSE / pyrad
- metpy
- jupyterlab_rise
- pip
- pip:
- git+https://github.com/pydata/xarray@d33e4ad9407591cc7287973b0f8da47cae396004
22 changes: 0 additions & 22 deletions environment.yml

This file was deleted.

54 changes: 26 additions & 28 deletions myst.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,29 +52,22 @@ project:
copyright: '2024'
toc:
- file: README.md
- title: Preamble
children:
- file: notebooks/how-to-cite.md
- title: Schedule
children:
- file: schedule.md
- file: notebooks/how-to-cite.md
- file: schedule.md
- title: Getting started
children:
- file: getting_started.md
- file: notebooks/data-access/intro-data-access.ipynb
- file: notebooks/environment.ipynb
- title: Radar Software Foundations
children:
- title: XRadar
children:
- file: notebooks/xradar-pyart/xradar-basics.ipynb
- file: presentations/intro-to-open-radar-science.ipynb
- file: notebooks/xradar-pyart/xradar-basics.ipynb
- title: Py-ART and wradlib
children:
- file: notebooks/xradar-pyart/pyart-basics.ipynb
- file: notebooks/wradlib/wradlib_clutter_beamblockage.ipynb
- title: GPM-API
children:
- file: notebooks/gpm-api/gpm-api-intro.ipynb
- file: notebooks/gpm-api/gpm-api-intro.ipynb
- title: BALTRAD
children:
- pattern: notebooks/baltrad/baltrad_short_course/*.ipynb
Expand All @@ -83,30 +76,33 @@ project:
- title: LROSE
children:
- file: notebooks/lrose/LROSE_Basics.ipynb
- file: notebooks/lrose/LROSE_ERAD_fractl_samurai.ipynb
- file: notebooks/lrose/DD_Tornado_ERAD2024.ipynb
- file: notebooks/lrose/DD_Tornado_ERAD24.ipynb

- file: notebooks/lrose/testing/stress_testing.ipynb
- title: Notebook Environment
children:
- file: notebooks/environment.ipynb
- title: Retrieving winds with PyDDA
children:
- file: notebooks/Retrieving_winds_with_pydda.ipynb
- title: ARCO Radar Datasets
- title: Project Workflows
children:
- file: notebooks/Analysis-Ready/ARCO-Datasets.ipynb
- file: notebooks/Analysis-Ready/QPE-QVPs.ipynb
- title: Spaceborne - Ground Radar Matching and Calibration
children:
- file: notebooks/gpm-api/SR_GR_Calibration_Applied.ipynb
- file: notebooks/gpm-api/SR_GR_Matching_Procedure.ipynb
- title: LROSE & PyDDA multi doppler analysis
children:
- file: notebooks/Retrieving_winds_with_pydda.ipynb
- file: notebooks/lrose/LROSE_ERAD_fractl_samurai.ipynb
- title: ARCO Radar Datasets
children:
- file: notebooks/Analysis-Ready/ARCO-Datasets.ipynb
- file: notebooks/Analysis-Ready/QPE-QVPs.ipynb
- title: Spaceborne - Ground Radar Matching and Calibration
children:
- file: notebooks/gpm-api/SR_GR_Calibration_Applied.ipynb
- file: notebooks/gpm-api/SR_GR_Matching_Procedure.ipynb
- file: notebooks/pyrad/description-pyrad-tutorial.ipynb
jupyter:
binder:
repo: openradar/erad2024
url: https://binder.projectpythia.org/
abbreviations:
ARM: Atmospheric Radiation Measurement
NCAR: National Center for Atmospheric Research
settings:
output_matplotlib_strings: remove
site:
options:
favicon: notebooks/images/icons/favicon.ico
Expand All @@ -115,8 +111,10 @@ site:
nav:
- title: Conference Home
url: https://www.erad2024.it
- title: Open Radar Community
- title: Community
url: https://openradarscience.org
- title: Discourse
url: https://openradar.discourse.group/
actions:
- title: Launch Environment
url: https://binder.projectpythia.org/v2/gh/openradar/erad2024/main?labpath=notebooks
Expand Down
20 changes: 9 additions & 11 deletions notebooks/environment.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Environment overview"
"# Environment overview\n",
"\n",
"This notebook gives a short over view over the installed packages and the environment.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"cell_type": "markdown",
"metadata": {},
"outputs": [],
"source": [
"!env"
"## Linux Environment"
]
},
{
Expand All @@ -22,16 +22,14 @@
"metadata": {},
"outputs": [],
"source": [
"!conda list"
"!env"
]
},
{
"cell_type": "code",
"execution_count": null,
"cell_type": "markdown",
"metadata": {},
"outputs": [],
"source": [
"import wradlib as wrl"
"## Conda Environment"
]
},
{
Expand All @@ -40,7 +38,7 @@
"metadata": {},
"outputs": [],
"source": [
"wrl.show_versions()"
"!conda list"
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion notebooks/how-to-cite.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to Cite This Cookbook
# How to Cite

The material in this Project Pythia Cookbook is licensed for free and open consumption and reuse. All code is served under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0), while all non-code content is licensed under [Creative Commons BY 4.0 (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/). Effectively, this means you are free to share and adapt this material so long as you give appropriate credit to the Cookbook authors and the Project Pythia community.

Expand Down
11 changes: 3 additions & 8 deletions notebooks/pyrad/description-pyrad-tutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"jp-MarkdownHeadingCollapsed": true
},
"source": [
"# Pyrad tutorial\n",
"# Pyrad QPE Exercise\n",
"\n",
"- An overview of pyrad is provided [here](../../presentations/pdf/Pyrad_architecture_and_principles.pdf).\n",
"- Pyrad documentation can be found [here](https://meteoswiss.github.io/pyrad/).\n",
Expand Down Expand Up @@ -84,8 +84,8 @@
"# Beyond QPE\n",
"\n",
"Pyrad has much more features available than just QPE. Have a look at the two config file sets that covers other projects discussed in this course:\n",
"- [Dual-Doppler analysis using PyDDA](../../pyrad/config/dda.txt)\n",
"- [Quasi-Vertical profiles](../../pyrad/config/qvp.txt)\n",
"- [Dual-Doppler analysis using PyDDA](../../pyrad/config-examples/dda.txt)\n",
"- [Quasi-Vertical profiles](../../pyrad/config-examples/qvp.txt)\n",
"\n",
"There are many more examples of config files available in the [Pyrad examples repository](https://github.com/MeteoSwiss/pyrad-examples/).\n",
"\n",
Expand All @@ -107,11 +107,6 @@
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
Expand Down
1 change: 1 addition & 0 deletions presentations/images/baltrad-functionality.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added presentations/images/baltrad-images.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 223991d

Please sign in to comment.