From 4cb9a116682fea71396de8138bbcea12b7c4d7e4 Mon Sep 17 00:00:00 2001 From: Daniel Wolfensberger Date: Tue, 28 Nov 2023 13:14:03 +0100 Subject: [PATCH] Update README.md --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 57 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 94eb5c8..95604b8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,57 @@ -# asean2024-pyrad-course -Repository for a pyrad course for the ASEAN-WMO workshop that will take place in Bangkok on the 28 Jan – 02 Feb 2024 +thumbnail + +# WMO/ASEAN radar workshop - Pyrad course + +[![Binder](http://binder.projectpythia.org/badge_logo.svg)](http://binder.projectpythia.org/v2/gh/openradar/asean2024-pyrad-course/main) + + +## Motivation + +This content will be used for the Pyrad short Course held at the WMO/ASEAN Weather Radar Workshop 2024. + +## Authors + +Jordi Figueras I Ventura, Daniel Wolfensberger + +## Running the Notebooks + +You can either run the notebook using [Binder](https://mybinder.org/) or on your local machine. + +### Running on Binder + +The simplest way to interact with a Jupyter Notebook is through +[Binder](https://mybinder.org/), which enables the execution of a +[Jupyter Book](https://jupyterbook.org) in the cloud. The details of how this works are not +important for now. All you need to know is how to launch a Pythia +Cookbooks chapter via Binder. Simply navigate your mouse to +the top right corner of the book chapter you are viewing and click +on the rocket ship icon, (see figure below), and be sure to select +“launch Binder”. After a moment you should be presented with a +notebook that you can interact with. I.e. you’ll be able to execute +and even change the example programs. You’ll see that the code cells +have no output at first, until you execute them by pressing +{kbd}`Shift`\+{kbd}`Enter`. Complete details on how to interact with +a live Jupyter notebook are described in [Getting Started with +Jupyter](https://foundations.projectpythia.org/foundations/getting-started-jupyter.html). + +### Running on Your Own Machine + +If you are interested in running this material locally on your computer, you will need to follow this workflow: + +(Replace "cookbook-example" with the title of your cookbooks) + +1. Clone the `https://github.com/openradar/ams-open-radar-2023` repository: + + ```bash + git clone https://github.com/openradar/asean2024-pyrad-course.git + ``` + +1. Move into the `asean2024-pyrad-course` directory + ```bash + cd asean2024-pyrad-course + ``` +1. Create and activate your conda environment from the `environment.yml` file + ```bash + conda env create -f environment.yml + conda activate asean2024-pyrad-course + ```