From 024f6260a80f5d69afa9cff1cdc6299621b1414b Mon Sep 17 00:00:00 2001
From: timothyas <timsmith204@utexas.edu>
Date: Fri, 27 Oct 2023 16:24:34 -0600
Subject: [PATCH] tested local install

---
 docs/installation.rst | 28 ++++++++++++++++++++--------
 pyproject.toml        |  5 +----
 2 files changed, 21 insertions(+), 12 deletions(-)

diff --git a/docs/installation.rst b/docs/installation.rst
index 212c7ee..be0f451 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -10,9 +10,18 @@ and install it as follows::
 
     git clone https://github.com/timothyas/xesn.git
     cd xesn
-    python setup.py install
+    pip install -e .
 
-or alternatively via pip::
+Note that additional dependencies can be installed to run the unit test suite,::
+
+    pip install -e .[test]
+    pytest xesn/test/*.py
+
+or to install `cupy <https://cupy.dev/>`_ to run on GPUs::
+
+    pip install -e .[gpus]
+
+Alternatively, the package can be installed via pip::
 
     pip install git+https://github.com/timothyas/xesn.git
 
@@ -22,12 +31,15 @@ the project and submit
 and
 `pull requests <https://github.com/timothyas/xesn/pulls>`_.
 
-Running the Example Notebooks
-=============================
+Running Example Notebooks or Building the Documentation Locally
+===============================================================
+
+Due to the way pandoc is installed via pip `as detailed here
+<https://stackoverflow.com/a/71585691>`_
+it is recommended to create an environment with conda in order to build the
+documentation locally.
+This is also recommended for running any of the example notebooks locally, since
+there are a couple of additional dependencies required::
 
-To run the example notebooks shown in this documentation, please first install a
-few additional dependencies::
-    
     conda env create -f docs/environment.yaml
     conda activate xesn
-
diff --git a/pyproject.toml b/pyproject.toml
index 97012a7..8152cf5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -9,16 +9,13 @@ license = {file = "LICENSE.txt"}
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [
-    "numpy", "scipy", "xarray", "dask[complete]", "zarr", "smt>=2.0.1",
+    "numpy", "scipy", "xarray", "dask[complete]", "zarr", "smt>=2.0.1", "matplotlib"
 ]
 
 [project.optional-dependencies]
 test = [
     "pytest", "coverage",
 ]
-docs = [
-    "sphinx", "sphinx_rtd_theme", "nbsphinx"
-]
 gpus = [
     "cupy"
 ]