From e573034a6b06df5ddd1be93e9c9e0082e6981ff6 Mon Sep 17 00:00:00 2001 From: elliesch Date: Tue, 8 Aug 2017 16:35:10 -0400 Subject: [PATCH] added requirements installation --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 873fe2f..ff4080a 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,18 @@ To install clone this repository: $ git clone https://github.com/BDNYC/UltracoolTypingKit $ cd UltracoolTypingKit/ $ mkdir new_types -$ pip install -r requirements.txt ``` +UltracoolTypingKit (UTK) requires Python 3.5 to run properly. We recommend running in an environment to ensure usage of the correct version of Python and all the necessary modules. + +```bash +$ conda create --name UTK python=3.5 ipython +$ source activate UTK +$ pip install -r requirements.txt + +``` + This code currently requires this directory tree to run properly: ``` @@ -35,24 +43,14 @@ UltracoolTypingKit/ ## Usage + -UltracoolTypingKit (UTK) requires Python 3.5 to run properly. We recommend running in an environment to ensure usage of the correct version of Python and all the necessary modules. +### 1. Running UTK +If you aren't already in the UTK environment, activate UTK. ```bash -$ conda create --name UTK python=3.5 ipython $ source activate UTK - -``` - -Later, when you're done spectral typing, you'll want to exit this environment. -```bash -$ source deactivate - ``` - - - -### 1. Running UTK UTK relies on an interactive backend and works best with `TkAgg`. ipython pylab uses this as its default.