[OpenScienceLab Cookbook Template] Replace with Your Title

This Cookbook Template was adapted from the Project Pythia Cookbook Template. It has been updated to provide templates for ASF Cookbooks using the Pixi package manager.

See the Project Pythia Cookbook Contributor's Guide for instructions on deploying your Cookbook to GitHub Pages.

This 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, Second Author, etc. Acknowledge primary content authors here! You can include links to their GitHub profiles or other unique pages.

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

Running in a Jupyter Hub

If you are working in a Jupyter Hub that allows you to build Pixi environments, such as OpenSARLab, use the following steps to run the notebooks in this cookbook.

1. Clone the repository:

    git clone https://github.com/your_account/your_cookbook.git

2. Run the notebooks/software_environment.ipynb notebook.

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 "your_account/your_cookbook" with the GitHub org or user name and title of your cookbook repository)

1. Create a copy of this Cookbook template repository, by clicking the Use this template button and selecting the Create a new repository option on this repository's GitHub page.

2. Clone the new repository:

    git clone https://github.com/your_account/your_cookbook.git

3. Move into the your_cookbook directory

   cd your_cookbook

4. Launch in Jupyter Lab with the included Pixi environment

   pix run lab