Commit be757d35 authored by Erik Frisk's avatar Erik Frisk

Update README.md with installation instructions.

parent 4e7e25bd
......@@ -10,3 +10,27 @@ Note that the generated plots are not identical to the results in the paper wher
If you have any questions, you are welcome to contact any of the authors
Erik Frisk (erik.frisk@lliu.se) or
Mattias Krysander (mattias.krysander@liu.se)
# Matlab installation instructions
Clone the git repository and run the file ```main.m``` in the ```code``` directory.
# Python installation instructions
You must pick the mechanism by which you install packages, here the Virtualenv approach is described. Below is a generic approach that should work on linux, MacOS, or Windows.
First, clone the git repository. Then, create a virtual environment
```bash
% python3 -m venv env
```
and install the necessary packages
```bash
% pip install numpy matplotlib scipy sklearn jupyterlab
```
Now, start 'JupyterLab' (or Jupyter Notebook if you prefer) and start exploring the notebook ```main.ipynb``` in the ```code``` directory by starting
```bash
% jupyter lab
```
or
```bash
% jupyter notebook
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment