Fix installation doc layout

replace/1ea623675883094701692f714343881f6dc5a4d1
JulioV 2019-12-11 18:44:37 -05:00
parent e9dab5687f
commit 0927321ded
1 changed files with 32 additions and 30 deletions

View File

@ -1,48 +1,50 @@
Installation
===============
- Install MySQL
This instructions have been tested on MacOS Cataline and Ubuntu 16.04. If you find a problem, please report it.
- brew install mysql
- brew services start mysql
Install MySQL
- Install R:
- ``brew install mysql``
- ``brew services start mysql``
- brew install r
Install R:
- Install miniconda
- ``brew install r``
- brew cask install miniconda
Install miniconda:
- Clone our repo
- ``brew cask install miniconda`` (for Mac)
Clone our repo:
- git clone https://github.com/JulioV/moshi-aware.git
- ``git clone https://github.com/JulioV/moshi-aware.git``
- Create a python virtual environment
Create a python virtual environment:
- conda env create -f environment.yml
- conda init zsh/bash
- Restart terminal if necessary
- conda activate moshi-env
- ``conda env create -f environment.yml``
- ``conda init zsh/bash``
- Restart terminal if necessary
- ``conda activate moshi-env``
- Install r packages:
Install r packages and virtual environment:
- snakemake packrat_install
- snakemake packrat_init
- snakemake packrat_restore
- ``snakemake packrat_install``
- ``snakemake packrat_init``
- ``snakemake packrat_restore``
- Configure the participants to analyze
Configure the participants to analyze:
- Add a file per participant. Name it with the label for that participant (p01 for example): "/data/external/pxx" (no extension is necessary)
- Add a line with the device_id for that participant as it appears on the db
- Add a line with the mobile platform (Android, or iOS)
- Add a file per participant and name it with the label for that participant, no extension is necessary: ``/data/external/pxx``
- Add a line with the device_id for that participant as it appears on the db
- Add a line with the mobile platform (Android, or iOS)
- Configure the db connection
Configure the db connection:
- Create an empty .env file in the root folder
- Add and complete the following lines
[MY_GROUP_NAME]
user=MyUSER
password=MyPassword
host=MyIP
port=3306
- Create an empty .env file in the root folder
- Add and complete the following lines
| ``[MY_GROUP_NAME]``
| ``user=MyUSER``
| ``password=MyPassword``
| ``host=MyIP``
| ``port=3306``