MSNoise Reproducible Papers

A curated registry of published studies that used MSNoise, or NOT! Each paper comes with a fully documented configuration and (where available) archived data bundles so results can be reproduced or used as a starting point for new studies.

What's in each paper folder

File	Purpose
project.yaml	Complete MSNoise configuration — importable directly via msnoise db init --from-yaml
citation.bib	BibTeX reference
README.md	Paper summary, network/period notes, known caveats
bundle_pointer.yaml	(when available) URLs + checksums for pre-computed data bundles
notebooks/	(when available) Jupytext notebooks to reproduce the figures

How to use a configuration

# 1. Clone this registry
git clone https://github.com/ROBelgium/MSNoise_Reproducible_Papers

# 2. Create a new MSNoise project and import a config
mkdir my_project && cd my_project
msnoise db init --from-yaml ../MSNoise_Reproducible_Papers/papers/2014_Lecocq_MSNoiseUndervolc/project.yaml

# 3. Run from scratch (requires FDSN access for example) or import a bundle
msnoise run preprocess

Papers

Year	Reference	Network	Approach	Data	MSNoise	E2E ✔	Project
2014	Lecocq et al., SRL	YA - Piton de la Fournaise, La Réunion	Foundation of MSNoise, CC-ZZ only	✅	✅	✅	🔗
2016	De Plaen et al., GRL	PF - Piton de la Fournaise, La Réunion	Single-station SC + AC, 4 frequency bands	✅	✅	❌	🔗
2019	De Plaen et al., Front. Earth Sci.	IV - Mt. Etna, Sicily, Italy	AC with PCC, velocity changes from volcanic activity	❌	✅	❌	🔗
2019	Yates et al., GRL	NZ - White Island (Whakaari), New Zealand	Single-station SC + AC, 2 frequency bands, volcanic/coseismic/seasonal separation	✅	✅	❌	🔗
2022	Wang et al., EPSL	YH - Northern Hikurangi margin, New Zealand (offshore)	SC on OBS data, dv/v related to slow slip events, MWCS	✅	✅	❌	🔗
2023	Yates et al., GJI	YA, NZ - Piton de la Fournaise, La Réunion + Mt. Ruapehu, New Zealand	CC + hierarchical clustering to assess CCF similarity; 2 sites, 2 frequency bands each	✅	✅	❌	🔗
2024	Yates et al., JGR Solid Earth	NZ - Mt. Ruapehu, New Zealand	SC + cross-wavelet transform; seasonal snow influence on dv/v and spring eruption timing	✅	✅	❌	🔗

Contributing

To add a paper, open a PR with a new folder under papers/ following this checklist:

Required files (CI will reject the PR if any are missing):

File	Content
project.yaml	Full MSNoise config, importable via msnoise db init --from-yaml
citation.bib	BibTeX entry
README.md	Paper summary, network/period notes, known caveats
meta.yaml	Display fields — copy from an existing paper and edit

Before opening the PR, run both scripts locally to regenerate the auto-derived files and verify everything looks correct:

python scripts/update_registry.py   # regenerates registry.yaml from all papers/*/meta.yaml + citation.bib + project.yaml
python scripts/update_readme.py     # regenerates the papers table in this README

Commit the updated registry.yaml and README.md as part of the PR. The CI will re-run both scripts and fail if the committed files are out of sync.