From 19ea0156f47ec9bb33cf3b17c68914054f8f95c1 Mon Sep 17 00:00:00 2001
From: Jonas Schuhmacher <jonas.schuhmacher@tum.de>
Date: Mon, 25 Mar 2024 20:06:21 +0100
Subject: [PATCH] add environment.yml for Jupyter Notebook (#33)

---
 script/environment.yml          | 9 +++++++++
 script/polyhedral-gravity.ipynb | 8 +++++++-
 2 files changed, 16 insertions(+), 1 deletion(-)
 create mode 100644 script/environment.yml

diff --git a/script/environment.yml b/script/environment.yml
new file mode 100644
index 0000000..fc9676e
--- /dev/null
+++ b/script/environment.yml
@@ -0,0 +1,9 @@
+name: polyhedral-gravity-jupyter-notebook
+channels:
+  - conda-forge
+dependencies:
+  - jupyter
+  - numpy
+  - matplotlib
+  - sympy
+  - polyhedral-gravity-model
diff --git a/script/polyhedral-gravity.ipynb b/script/polyhedral-gravity.ipynb
index f93b27f..350c2f3 100644
--- a/script/polyhedral-gravity.ipynb
+++ b/script/polyhedral-gravity.ipynb
@@ -10,7 +10,13 @@
    "source": [
     "# The polyhedral gravity model - Python interface\n",
     "\n",
-    "First some imports:\n"
+    "The dependencies required to run this notebook can be found in the `environment.yml` file. You can create a conda environment with the required dependencies by running:\n",
+    "\n",
+    "```bash\n",
+    "conda env create -f environment.yml\n",
+    "```\n",
+    "\n",
+    "Using this environment, you can start executing this notebook cell by cell:\n"
    ]
   },
   {