From 996be8e8cfa3e6a8a92ac9465253e7907d99f22e Mon Sep 17 00:00:00 2001 From: joeb42 <70596457+joeb42@users.noreply.github.com> Date: Wed, 28 Dec 2022 15:45:50 +0000 Subject: [PATCH] update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 70b1ef1..a8e5d5d 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ It is then a mere matter of solving a matrix equation at each time step. This ca ## Running Note this project depends on tkinter so make sure you are running a python distribution that is compatible (I built this project using miniconda).
If using miniconda ensure you have pip installed into your environment with ```conda install pip```.
-Run the command ```pip install -e .``` to install all dependencies.
+Run the command ```pip install .``` to install all dependencies, or ```pip install -e .``` if you would like to make your own alterations to the code.
Run ```python main.py```: this should pop up a GUI window and you should be able to select some options and run the simulution with the animation in the window.
### Docker Alternatively use the included Dockerfile to build the docker image. Be aware that running GUI application using docker can be fiddly. To get this running on my mac I followed the instruction [here](https://gist.github.com/paul-krohn/e45f96181b1cf5e536325d1bdee6c949).