diff --git a/README.md b/README.md index 887803b4ad97579bb42caa980404fe3ed7ce7859..b70a2d9082d9c46444b28a3b432b5e51e0b3f336 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,28 @@ Clone or download this repository as a .zip. If you don't already have Anaconda to run Jupyter Notebooks. We suggest two options: **Miniconda** -TODO: Setup instructions +1. Go to https://docs.conda.io/en/latest/miniconda.html and download the latest version + - Mac: Choose the `.pkg` + +2. Install Miniconda + - Windows: + Billy? + - Mac: + - Execute the `.pkg` + - Select a directory for installation + - If in MacOS Catalina or later, you have to do some extra steps: + - Open a terminal window + - Run `source <full path to installation directory>/opt/miniconda3/bin/activate` + - Run `conda init zsh` + - Linux: + - Navigate to the folder with the downloaded `.sh` file + - Open the terminal in this folder (right click on the folder and select open terminal) + - Change permissions to install by running `chmod 700 <filename>.sh` + - To install, type `<filename>.sh` **Google Colab** -Link to notebook + +Billy? ## 3. Set up environment Unless you are using Google Colab, you will need to run the file called environment.yml to install the required packages via the command line.