Update Notebook (#10)

Author: cyschneck

CITATION.cff

@@ -1,48 +1,12 @@
 cff-version: 1.2.0
 message: "If you use this cookbook, please cite it as below."
 authors:
-  # add additional entries for each author -- see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
-  - family-names: Rose
-    given-names: Brian E. J.
-    orcid: https://orcid.org/0000-0002-9961-3821 # optional
-    website: https://github.com/brian-rose # optional
-    affiliation: University at Albany (State University of New York) # optional
-  - family-names: Kent
-    given-names: Julia
-    orcid: https://orcid.org/0000-0002-5611-8986
-    website: https://github.com/jukent
+  - family-names: Schneck
+    given-names: Cora
+    orcid: https://orcid.org/0009-0009-1415-5170
+    website: https://github.com/cyschneck
     affiliation: UCAR/NCAR
-  - family-names: Tyle
-    given-names: Kevin
-    orcid: https://orcid.org/0000-0001-5249-9665
-    website: https://github.com/ktyle
-    affiliation: University at Albany (State University of New York)
-  - family-names: Clyne
-    given-names: John
-    orcid: https://orcid.org/0000-0003-2788-9017
-    website: https://github.com/clyne
-    affiliation: UCAR/NCAR
-  - family-names: Camron
-    given-names: Drew
-    orcid: https://orcid.org/0000-0001-7246-6502
-    website: https://github.com/dcamron
-    affiliation: UCAR/Unidata
-  - family-names: Grover
-    given-names: Maxwell
-    orcid: https://orcid.org/0000-0002-0370-8974
-    website: https://github.com/mgrover1
-    affiliation: Argonne National Laboratory
-  - family-names: Ford
-    given-names: Robert R.
-    orcid: https://orcid.org/0000-0001-5483-4965
-    website: https://github.com/r-ford
-    affiliation: University at Albany (State University of New York)
-  - family-names: Paul
-    given-names: Kevin
-    orcid: https://orcid.org/0000-0001-8155-8038
-    website: https://github.com/kmpaul
-    affiliation: NVIDIA
-  - name: "Cookbook Template contributors" # use the 'name' field to acknowledge organizations
+  - name: "Wavelet Cookbook contributors" # use the 'name' field to acknowledge organizations
     website: "https://github.com/ProjectPythia/wavelet-cookbook/graphs/contributors"
-title: "Cookbook Template"
-abstract: "A sample cookbook description."
+title: "Wavelet Cookbook"
+abstract: "A cookbook to learn to work with wavelets in Python"

README.md

@@ -6,10 +6,10 @@
 [![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/wavelet-cookbook/main?labpath=notebooks)
 [![DOI](https://zenodo.org/badge/815311051.svg)](https://zenodo.org/badge/latestdoi/815311051)
 
-This Project Pythia Cookbook covers working with wavelets in Python
+This Project Pythia Cookbook covers how to work with wavelets in Python
 
 ## Motivation
-Wavelets are a powerful tool to analysis time-series data. When data frequencies vary over time, wavelets can be applied to analysis trends and overcome the time vs. frequency limitations of Fourier Transforms
+Wavelets are a powerful tool to analyze time-series data. When data frequencies vary over time, wavelets can be applied to analysis trends and overcome the time/frequency limitations of Fourier Transforms
 
 ## Authors
 
@@ -26,17 +26,17 @@ Wavelets are a powerful tool to analysis time-series data. When data frequencies
 This cookbook is broken into two main sections:
 
 - Foundations
-- Example Workflow
+- Example Workflows
 
 ### Foundations
 
-"Wavelet Basics" covers the motivation and background for wavelet analysis by review time-series data and the strengths and weaknesses of Fourier transform
+_"Wavelet Basics"_ covers the motivation and background for wavelet analysis by reviewing time-series data and the strengths and weaknesses of other signal analysis tools like Fourier Transform
 
 ### Example Workflows
 
-- "PyWavelets and Jingle Bells": Learn how to use `PyWavelets`, a Python implementation of wavelet analysis, to determine the order of notes in a simple musical piece
-- "Spy Keypad": Learn how to use wavelets to undercover the frequency and order of notes in an unkonwn piece of audio data
-- "Atmospheric Data: nino3": Replicate the power wavelet scalogram from the original 1999 Torrence and Compo paper in Python
+- _"PyWavelets and Jingle Bells"_: Learn how to use `PyWavelets`, a Python implementation of wavelet analysis, to determine the order of notes in a simple musical piece
+- _"Spy Keypad"_: Learn how to use wavelets to undercover the frequency and order of notes in an unknown piece of audio data
+- _"Atmospheric Data: Nino 3 SST Index"_: Learn how to apply wavelets to real atmospheric and oceanic data to generate a power wavelet scalogram, similiar to the 1999 paper ["A Practical Guide to Wavelet Analysis"](https://psl.noaa.gov/people/gilbert.p.compo/Torrence_compo1998.pdf) by Torrence and Compo in Python
 
 ## Running the Notebooks
 

_config.yml

@@ -27,7 +27,7 @@ parse:
 
 sphinx:
   config:
-    linkcheck_ignore: ["https://doi.org/*", "https://zenodo.org/badge/*"] # don't run link checker on DOI links since they are immutable
+    linkcheck_ignore: ["https://doi.org/*","https://zenodo.org/badge/*", "https://www.mathworks.com/*"] # don't run link checker on DOI links since they are immutable
     nb_execution_raise_on_error: true # raise exception in build if there are notebook errors (this flag is ignored if building on binder)
     html_favicon: notebooks/images/icons/favicon.ico
     html_last_updated_fmt: "%-d %B %Y"

_gallery_info.yml

@@ -1,6 +1,15 @@
 thumbnail: thumbnail.png
 tags:
   domains:
-    - sampledomain
+    - signal analysis
+    - wavelet
+    - data science
+    - fourier transform
   packages:
-    - samplepackage
+    - geocat-datafiles
+    - numpy
+    - xarray
+    - matplotlib
+    - scipy
+    - pandas
+    - pywavelets

notebooks/example-workflows/jingle-bells.ipynb

@@ -4,4 +4,4 @@ The material in this Project Pythia Cookbook is licensed for free and open consu
 
 The source code for the book is [released on GitHub](https://github.com/ProjectPythia/wavelet-cookbook) and archived on Zenodo. This DOI will always resolve to the latest release of the book source:
 
-[![DOI](https://zenodo.org/badge/815311051.svg)](https://zenodo.org/badge/latestdoi/815311051)
+[![DOI](https://zenodo.org/badge/815311051.svg)](https://zenodo.org/badge/latestdoi/815311051)