From 1e7a3d6d2ea1ba4887f122a96a5a292ca6b7f789 Mon Sep 17 00:00:00 2001 From: Kevin Tyle Date: Fri, 24 Jun 2022 15:54:49 +0000 Subject: [PATCH 1/2] Initial rewrite of landing-page.md to make more generic --- notebooks/landing-page.md | 66 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 64 insertions(+), 2 deletions(-) diff --git a/notebooks/landing-page.md b/notebooks/landing-page.md index 312f9689b..66cbdb681 100644 --- a/notebooks/landing-page.md +++ b/notebooks/landing-page.md @@ -1,3 +1,65 @@ -# Cookbook Overview +# (Replace_with_your_title) Cookbook -This is the the landing page for your cookbook - update as neccessary! +This Project Pythia Cookbook covers ... (replace `...` with the main subject of your cookbook ... e.g., *working with radar data in Python*) + +## Motivation + +(Add a few sentences stating why this cookbook will be useful. What skills will you, "the chef", gain once you have reached the end of the cookbook?) + +## Structure +(State one or more sections that will comprise the notebook. E.g., *This cookbook is broken up into two main sections - "Foundations" and "Example Workflows."* Then, describe each section below.) + +### Section 1 ( Replace with the title of this section, e.g. "Foundations" ) +(Add content for this section, e.g., "The foundational content includes ... ") + +### Section 2 ( Replace with the title of this section, e.g. "Example workflows" ) +(Add content for this section, e.g., "Example workflows include ... ") + +## 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 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 ["cookbook-example"](https://github.com/ProjectPythiaTutorials/cookbook-example) repository + ```bash + git clone https://github.com/ProjectPythiaTutorials/cookbook-example.git + ``` + +2. Move into the `cookbook-example` directory + ```bash + cd radar-cookbook + ``` + +3. Create and activate your conda environment from the `environment.yml` file + ```bash + conda env create -f environment.yml + conda activate radar-cookbook-dev + ``` + +4. Move into the `notebooks` directory and start up Jupyterlab + ```bash + cd notebooks/ + jupyter lab + ``` + +At this point, you can interact with the notebooks! Make sure to check out the ["Getting Started with Jupyter"](https://foundations.projectpythia.org/foundations/getting-started-jupyter.html) content from the [Pythia Foundations](https://foundations.projectpythia.org/landing-page.html) material if you are new to Jupyter or need a refresher. From afe029ea6aeb4aa602e7210b6f9ee318ee305d10 Mon Sep 17 00:00:00 2001 From: Kevin Tyle Date: Fri, 24 Jun 2022 19:40:01 +0000 Subject: [PATCH 2/2] Edited landing-page.md --- notebooks/landing-page.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/notebooks/landing-page.md b/notebooks/landing-page.md index 66cbdb681..4df6276d3 100644 --- a/notebooks/landing-page.md +++ b/notebooks/landing-page.md @@ -22,7 +22,7 @@ You can either run the notebook using [Binder](https://mybinder.org/) or on your The simplest way to interact with a Jupyter Notebook is through [Binder](https://mybinder.org/), which enables the execution of a -Jupyter Book in the cloud. The details of how this works are not +[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 @@ -36,30 +36,30 @@ 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) +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 ["cookbook-example"](https://github.com/ProjectPythiaTutorials/cookbook-example) repository - ```bash +1. Clone the `https://github.com/ProjectPythiaTutorials/cookbook-example` repository: + + ```bash git clone https://github.com/ProjectPythiaTutorials/cookbook-example.git - ``` - -2. Move into the `cookbook-example` directory + ``` +1. Move into the `cookbook-example` directory ```bash - cd radar-cookbook - ``` - -3. Create and activate your conda environment from the `environment.yml` file + cd cookbook-example + ``` +1. Create and activate your conda environment from the `environment.yml` file ```bash conda env create -f environment.yml - conda activate radar-cookbook-dev - ``` - -4. Move into the `notebooks` directory and start up Jupyterlab + conda activate cookbook-example + ``` +1. Move into the `notebooks` directory and start up Jupyterlab ```bash cd notebooks/ jupyter lab ``` At this point, you can interact with the notebooks! Make sure to check out the ["Getting Started with Jupyter"](https://foundations.projectpythia.org/foundations/getting-started-jupyter.html) content from the [Pythia Foundations](https://foundations.projectpythia.org/landing-page.html) material if you are new to Jupyter or need a refresher. + +