Skip to content

Commit 06c2ca7

Browse files
committed
Add EGG processing tutorial notebook with Wolpert sample data
First tutorial for GastroPy: a 45-cell Jupyter notebook that walks through the complete EGG analysis pipeline using real data from Wolpert et al. (2020). Covers spectral analysis, channel selection, bandpass filtering, Hilbert phase extraction, cycle detection, artifact detection, quality metrics, and multi-band analysis. All outputs pre-computed and embedded for Sphinx rendering.
1 parent e3e6b45 commit 06c2ca7

4 files changed

Lines changed: 1314 additions & 9 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,16 @@ phases = apply_volume_cuts(phases, begin_cut=21, end_cut=21)
157157
fig, ax = gp.plot_volume_phase(phases, tr=1.856, cut_start=21, cut_end=21)
158158
```
159159

160+
## Tutorials
161+
162+
Learn EGG processing from scratch with our step-by-step tutorial using real
163+
data from Wolpert et al. (2020):
164+
165+
- **[EGG Signal Processing](https://embodied-computation-group.github.io/gastropy/tutorials/egg_processing.html)**
166+
Load multi-channel EGG data, compute PSD, select the best channel, bandpass
167+
filter, extract phase and amplitude, detect artifacts, compute quality
168+
metrics, and run multi-band analysis. No prior EGG experience needed.
169+
160170
## Documentation
161171

162172
Full API reference and tutorials at

docs/getting_started.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,9 @@ normogastria, tachygastria) for per-band metrics.
197197
What's Next
198198
-----------
199199

200+
For a hands-on walkthrough using real EGG data, see the
201+
:doc:`EGG Signal Processing Tutorial <tutorials/egg_processing>`.
202+
200203
GastroPy is under active development. Upcoming modules include
201204
gastric-brain phase coupling, data I/O with BIDS support, and
202205
statistical testing. See the :doc:`API Reference <api/index>`

docs/tutorials/egg_processing.ipynb

Lines changed: 1295 additions & 0 deletions
Large diffs are not rendered by default.

docs/tutorials/index.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
Tutorials
22
=========
33

4-
Tutorials will be added here as GastroPy modules are implemented.
5-
Each tutorial is a Jupyter notebook demonstrating a specific aspect
6-
of the EGG processing pipeline.
4+
Step-by-step guides demonstrating how to use GastroPy for EGG signal
5+
processing and analysis.
76

8-
.. Planned tutorials:
9-
- Loading and inspecting EGG data
10-
- EGG signal preprocessing
11-
- Time-frequency analysis of gastric rhythm
12-
- Computing EGG metrics
13-
- Gastric-brain coupling with fMRI
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
egg_processing

0 commit comments

Comments
 (0)