Merge pull request DynamicsAndNeuralSystems#23 from DynamicsAndNeuralSystems/dev_docker

Docker image

Author: benfulcher

Dockerfile

@@ -0,0 +1,24 @@
+# Debian linux distribution with python 3.9
+FROM --platform=linux/amd64 python:3.9-slim-buster
+
+# Set the working directory
+WORKDIR /pyspi_project
+
+# Copy the current directory contents into the container
+COPY . .
+
+# Update the package index and install essential packages
+RUN apt-get update && apt-get install -y build-essential octave
+
+# Upgrade pip and setuptools
+RUN pip install --upgrade pip setuptools
+
+# Install any needed packages specified in requirements.txt
+RUN pip install --no-cache-dir -r requirements.txt && \
+    python setup.py install
+
+# Make port 80 available to communicate with other containters if needed
+# EXPOSE 80
+
+# Run app.py when the container launches
+CMD ["python"]

docs/source/installation.rst

@@ -27,12 +27,25 @@ Next, download or clone the `latest version <https://github.com/olivercliff/pysp
 
 .. code-block:: console
 
-   $ git clone https://github.com/olivercliff/pyspi.git 
+   $ git clone https://github.com/olivercliff/pyspi.git
    $ cd pyspi
    $ pip install .
 
 You can confirm that `pyspi` and dependencies installed properly with the following command:
 
 .. code-block:: console
 
-   $ setup.py test
+   $ setup.py test
+
+Docker Image
+------------
+
+Alternatively, you can use the `pyspi Docker image <https://hub.docker.com/r/arianguyen/pyspi>`_, which contains all the dependencies and the toolkit itself.
+After downloading Docker Desktop and creating an account, you can run the following commands to pull and run the image:
+
+.. code-block:: console
+
+   $ docker pull arianguyen/pyspi:v1.0
+   $ docker run -it arianguyen/pyspi:v1.0
+
+This should start a python session with `pyspi` installed and ready to import.