add environment.yml for Jupyter Notebook (#33)

esa · Mar 25, 2024 · 19ea015 · 19ea015
1 parent d9fad61
commit 19ea015
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/script/environment.yml 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
@@ -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"
    ]
   },
   {