Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cannin authored Aug 27, 2019
1 parent 1f760da commit 56ff48e
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/dfci/CellBox/master)

# Installation

In pertbio folder run:
Expand All @@ -8,17 +10,22 @@ python3.6 setup.py install

Only python3.6 supported. Anaconda or pipenv is recommended to create python environment

# Quick start
# Quick Start
Now you can test if the installation is successful

```
import pertbio
pertbio.VERSION
```

To quickly start an example model training, use Binder
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/dfci/CellBox/master)
New dropdown -> Terminal
## Quick Start with Binder

Easily try PertBio online with Binder

1. Go to: https://mybinder.org/v2/gh/dfci/CellBox/master
2. From the New dropdown, click Terminal
3. Run the following command:

```
python scripts/main.py -config=configs/example.cfg.json
```
Expand Down

0 comments on commit 56ff48e

Please sign in to comment.