pupster90/mindreader repository overview

⁠How to Launch MindReader

This tutorial is for people who want to run MindReader on their computer locally. By far the easiest way to do this is using Docker⁠. Docker has quickly become one of the most popular ways to share code, because it makes it easy to instantly run any code on any computer.

⁠Step 1: Install Docker

You can run MindReader on Linux/Mac/Windows laptops using docker. To do this, first install docker here⁠. We recommend watching a docker tutorial and installation video on youtube⁠.

⁠Step 2: Download and Run MindReader

The first step is to download the MindReader code⁠ from Github. Let's say you want to download the code to a specific folder on your computer, let's call it /your/path/. To do this type

cd /your/path
git clone https://github.com/pupster90/mind-reader.git

Once you have docker, open your computer terminal and run the following code to download the MindReader docker image:

docker pull pupster90/mindreader

Now that you have the source code and docker, you can type the following command to run the docker image.

docker run -it -p 8880:8080 -p 8881:8000 -p 80:8888 -v /your/local/path/mind-reader:/root/Documents/ --name mindreader pupster90/mindreader /bin/bash

You will now notice that the terminal has changed. This is because you are inside of the docker container's terminal which is used to launch the MindReader website. From here you can type the commands below to either launch the website or jupyter.

⁠Step 3: Run MindReader Website

The MinderReader website is launched using google app engine⁠. Inside of the MindReader docker container, type:

cd /root/Documents/website/freunds-mind-reader
dev_appserver.py --host=0.0.0.0 app.yaml

Now you can open a web browser (ex: google chrome) and go to localhost:8880. You will see the website there. Note, sometimes you may have to remove "--host=0.0.0.0" to get this working.

⁠Run Jupyter

Jupyter was used to do data analysis. To launch jupyter run the following commands from inside of the MindReader docker container.

cd /root/Documents/Data_Analysis
jupyter notebook

Now open up a web browser and go to localhost to see jupyter. Type the password: yoavfreund to access the coding environement.

Note: There's R code that was also used to analyze the data. Email Matthew Elliott if you want to use it. email: [email protected]⁠