Skip to content

Commit

Permalink
📚 Update docs to reflect new install method
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnGiorgi committed Jan 21, 2019
1 parent 435a9bc commit f9b0435
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 13 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,16 @@ $ conda activate saber
(saber) $
```

then install Saber right from this repository with `pip`
then install Saber

```sh
(saber) $ pip install git+https://github.com/BaderLab/saber.git
(saber) $ pip install saber
```

To get the latest development version of Saber, install it right from this repository with `pip`

```sh
(saber) $ pip install https://github.com/BaderLab/saber.git
```

or by cloning the repository and then using `pip` to install the package
Expand All @@ -70,7 +76,7 @@ or by cloning the repository and then using `pip` to install the package
(saber) $ pip install .
```

finally, install the required [Spacy](https://spacy.io) model and the [keras-contrib](https://github.com/keras-team/keras-contrib) repository
For now, you will need to install the required [Spacy](https://spacy.io) model and the [keras-contrib](https://github.com/keras-team/keras-contrib) repository (even if you installed with `pip install saber`)

```sh
# keras-contrib
Expand Down
23 changes: 13 additions & 10 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,34 +9,37 @@ To install Saber, you will need `python>=3.5`. If not already installed, `python
!!! note
Run `python --version` at the command line to make sure installation was successful. You may need to type `python3` (not just `python`) depending on your install method.

(OPTIONAL) First, activate your virtual environment (see [below](#optional-creating-and-activating-virtual-environments) for help)
(OPTIONAL) Activate your virtual environment (see [below](#optional-creating-and-activating-virtual-environments) for help)

```
```sh
$ conda activate saber
# Notice your command prompt has changed to indicate that the environment is active
(saber) $
```

then install Saber right from the repository with `pip`
then install Saber

```sh
(saber) $ pip install saber
```
(saber) $ pip install git+https://github.com/BaderLab/saber.git

To get the latest development version of Saber, install it right from this repository with `pip`

```sh
(saber) $ pip install https://github.com/BaderLab/saber.git
```

or by cloning the repository and then using `pip` to install the package

```
```sh
(saber) $ git clone https://github.com/BaderLab/saber.git
(saber) $ cd saber
(saber) $ pip install .
```

!!! tip
You can also install Saber by cloning this repository and running `python setup.py install`.

finally, install the required [Spacy](https://spacy.io) model and the [keras-contrib](https://github.com/keras-team/keras-contrib) repository
For now, you will need to install the required [Spacy](https://spacy.io) model and the [keras-contrib](https://github.com/keras-team/keras-contrib) repository (even if you installed with `pip install saber`)

```
```sh
# keras-contrib
(saber) $ pip install git+https://www.github.com/keras-team/keras-contrib.git
# NeuralCoref medium model built on top of Spacy, this might take a few minutes to download!
Expand Down

0 comments on commit f9b0435

Please sign in to comment.