Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgrover1/vap-fun-cookbook
Project for the ARM Summer School
https://github.com/mgrover1/vap-fun-cookbook
Last synced: about 11 hours ago
JSON representation
Project for the ARM Summer School
- Host: GitHub
- URL: https://github.com/mgrover1/vap-fun-cookbook
- Owner: mgrover1
- License: apache-2.0
- Created: 2024-05-21T17:26:05.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-05-21T17:41:47.000Z (6 months ago)
- Last Synced: 2024-06-14T20:24:37.525Z (5 months ago)
- Language: Jupyter Notebook
- Size: 266 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# (Replace_with_your_title) Cookbook
[](https://github.com/ProjectPythia/cookbook-template/actions/workflows/nightly-build.yaml)
[](https://binder.projectpythia.org/v2/gh/ProjectPythia/cookbook-template/main?labpath=notebooks)
[](https://zenodo.org/badge/latestdoi/475509405)
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?)
## Authors
[First Author](@first-author), [Second Author](@second-author), etc. _Acknowledge primary content authors here_
### Contributors
## 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://binder.projectpythia.org/) or on your local machine.
### Running on Binder
The simplest way to interact with a Jupyter Notebook is through
[Binder](https://binder.projectpythia.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/ProjectPythia/cookbook-example` repository:
```bash
git clone https://github.com/ProjectPythia/cookbook-example.git
```
1. Move into the `cookbook-example` directory
```bash
cd cookbook-example
```
1. Create and activate your conda environment from the `environment.yml` file
```bash
conda env create -f environment.yml
conda activate cookbook-example
```
1. Move into the `notebooks` directory and start up Jupyterlab
```bash
cd notebooks/
jupyter lab
```