Skip to content

Commit

Permalink
added requirements installation
Browse files Browse the repository at this point in the history
  • Loading branch information
elliesch committed Aug 8, 2017
1 parent ed2ae33 commit e573034
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
Expand All @@ -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.

Expand Down

0 comments on commit e573034

Please sign in to comment.