Merge pull request ML4GW#180 from wbenoit26/add-tutorial-notebook

Add demo notebook
EthanMarx · Jan 30, 2025 · 7f49127 · 7f49127
2 parents 00e0f22 + da52ee0
commit 7f49127
Show file tree

Hide file tree

Showing 4 changed files with 5,636 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,13 @@
+# [`ml4gw`](https://github.com/ML4GW/ml4gw) Tutorial
+
+This repo hosts the Jupyter notebook and the environment files for the `ml4gw` tutorial.
+
+If you use `poetry`, the environment can be installed and a Jupyter kernel created with
+```bash
+poetry install
+poetry run python -m ipykernel install --user --name ml4gw_tutorial
+```
+
+If you use a different environment manager, all of the packages listed in the `pyproject.toml` file can be `pip install`ed into whatever environment you desire.
+
+The background data files used in this tutorial can be copied from `/home/william.benoit/ML4GW/ml4gw_tutorial/background_data` on the Hanford computing cluster.
diff --git a/examples/ml4gw_tutorial.ipynb b/examples/ml4gw_tutorial.ipynb