wavelet-cookbook

Wavelet Analysis in Python for Geoscience

https://github.com/projectpythia/wavelet-cookbook

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Wavelet Analysis in Python for Geoscience

Basic Info
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 6
  • Open Issues: 1
  • Releases: 2
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

Wavelet Cookbook

thumbnail

nightly-build Binder DOI

This Project Pythia Cookbook covers the background and how to work with wavelets in Python

Motivation

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

Cora Schneck

Contributors

Structure

This cookbook is broken into two main sections:

  • Introduction
  • Example Geoscience Workflows

Introduction

  • "Wavelet Basics": Understand 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
  • "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

Geoscience Workflows

  • "Atmospheric Data: Nino 3 SST Index": Learn how to apply wavelets to real atmospheric and oceanic data to generate a power wavelet scalogram, similar to the 1999 paper "A Practical Guide to Wavelet Analysis" by Torrence and Compo in Python
  • "Buoys and Wave(let)s": Apply wavelets to understand how wave heights and energy change over years of data with historical records from NOAA's National Data Buoy Center

Running the Notebooks

You can either run the notebook using Binder or on your local machine.

Running on Binder

The simplest way to interact with a Jupyter Notebook is through Binder, 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.

Running on Your Own Machine

If you are interested in running this material locally on your computer, you will need to follow this workflow:

  1. Clone the https://github.com/ProjectPythia/wavelet-cookbook repository:

bash git clone https://github.com/ProjectPythia/wavelet-cookbook.git

  1. Move into the wavelet-cookbook directory bash cd wavelet-cookbook
  2. Create and activate your conda environment from the environment.yml file bash conda env create -f environment.yml conda activate cookbook-dev
  3. Move into the notebooks directory and start up Jupyterlab bash cd notebooks/ jupyter lab

Owner

  • Name: Project Pythia
  • Login: ProjectPythia
  • Kind: organization
  • Email: projectpythia@ucar.edu
  • Location: United States of America

Community learning resource for Python-based computing in the geosciences

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this cookbook, please cite it as below."
authors:
  - family-names: Schneck
    given-names: Cora
    orcid: https://orcid.org/0009-0009-1415-5170
    website: https://github.com/cyschneck
    affiliation: UCAR/NCAR
  - name: "Wavelet Cookbook contributors" # use the 'name' field to acknowledge organizations
    website: "https://github.com/ProjectPythia/wavelet-cookbook/graphs/contributors"
title: "Wavelet Cookbook"
abstract: "A cookbook to learn to work with wavelets in Python"

GitHub Events

Total
  • Create event: 3
  • Release event: 2
  • Issues event: 3
  • Watch event: 3
  • Delete event: 3
  • Issue comment event: 22
  • Push event: 119
  • Pull request review comment event: 1
  • Pull request review event: 4
  • Pull request event: 17
  • Fork event: 1
Last Year
  • Create event: 3
  • Release event: 2
  • Issues event: 3
  • Watch event: 3
  • Delete event: 3
  • Issue comment event: 22
  • Push event: 119
  • Pull request review comment event: 1
  • Pull request review event: 4
  • Pull request event: 17
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 9
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 11 hours
  • Total issue authors: 2
  • Total pull request authors: 6
  • Average comments per issue: 4.0
  • Average comments per pull request: 1.22
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 2
  • Pull requests: 9
  • Average time to close issues: about 1 month
  • Average time to close pull requests: about 11 hours
  • Issue authors: 2
  • Pull request authors: 6
  • Average comments per issue: 4.0
  • Average comments per pull request: 1.22
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 2
Top Authors
Issue Authors
  • erogluorhan (1)
  • cyschneck (1)
Pull Request Authors
  • cyschneck (12)
  • dependabot[bot] (2)
  • erogluorhan (1)
  • Christian-Kofi-Okyere (1)
  • brian-rose (1)
  • jukent (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (2) github_actions (2)

Dependencies

.github/workflows/nightly-build.yaml actions
.github/workflows/publish-book.yaml actions
.github/workflows/trigger-book-build.yaml actions
.github/workflows/trigger-delete-preview.yaml actions
.github/workflows/trigger-link-check.yaml actions
.github/workflows/trigger-preview.yaml actions
.github/workflows/trigger-replace-links.yaml actions
  • actions/checkout v4 composite
  • jacobtomlinson/gha-find-replace v3 composite
  • stefanzweifel/git-auto-commit-action v5 composite
environment.yml pypi