Setup and Example Cookbooks

README.md

@@ -1,36 +1,36 @@
 <img src="thumbnail.png" alt="thumbnail" width="300"/>
 
-# (Replace_with_your_title) Cookbook
+# Wavelet Cookbook
 
 [![nightly-build](https://github.com/ProjectPythia/cookbook-template/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/cookbook-template/actions/workflows/nightly-build.yaml)
 [![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/cookbook-template/main?labpath=notebooks)
 [![DOI](https://zenodo.org/badge/475509405.svg)](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_)
+This Project Pythia Cookbook covers working with wavelets 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_
+[Cora Schneck](https://github.com/cyschneck)
 
 ### Contributors
 
-<a href="https://github.com/ProjectPythia/cookbook-template/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=ProjectPythia/cookbook-template" />
+<a href="https://github.com/ProjectPythia/wavelet-cookbook/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ProjectPythia/wavelet-cookbook" />
 </a>
 
 ## 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" )
+### 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" )
+### Example Workflows
 
 (Add content for this section, e.g., "Example workflows include ... ")
 
@@ -74,7 +74,7 @@ If you are interested in running this material locally on your computer, you wil
 1. Create and activate your conda environment from the `environment.yml` file
    ```bash
    conda env create -f environment.yml
-   conda activate cookbook-example
+   conda activate cookbook-dev
    ```
 1. Move into the `notebooks` directory and start up Jupyterlab
    ```bash

_toc.yml

@@ -6,4 +6,9 @@ parts:
       - file: notebooks/how-to-cite
   - caption: Introduction
     chapters:
-      - file: notebooks/notebook-template
+      - file: notebooks/wavelet-introduction/wavelet-basics
+  - caption: Example Workflows
+    chapters:
+      - file: notebooks/example-workflows/jingle-bells
+      - file: notebooks/example-workflows/spy-sounds
+      - file: notebooks/example-workflows/nino3

environment.yml

@@ -5,3 +5,8 @@ dependencies:
   - jupyter-book
   - jupyterlab
   - sphinx-pythia-theme
+  - numpy
+  - matplotlib
+  - pandas
+  - scipy
+  - pywavelets