Skip to content

Commit 42c3958

Browse files
committed
Update docs
1 parent 41955dc commit 42c3958

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ into data. PLoS Comp Biol. doi: https://doi.org/10.1371/journal.pcbi.1007625
2525
The following is a short tutorial showing you how to install XPRESSpipe:
2626
[![asciicast](https://asciinema.org/a/262192.svg)](https://asciinema.org/a/262192?speed=4)
2727

28+
NOTE: Previous versions utilized the `pip install .` command to install. Users of >= v0.6.3 should instead use `bash install.sh`
29+
2830
- Make sure you let Anaconda set up the PATH info for you.
2931
- If the help menu is not displayed when testing, try adding the path where you installed XPRESSpipe to the system PATH
3032
```
@@ -33,12 +35,12 @@ $ echo 'export PATH=$PATH:/path/to/xpresspipe' >> ~/.bash_profile
3335
- If you do not have a file names `~/.bash_profile`, try looking for one called `~/.profile`
3436
- The commands used in the video above are summarized here:
3537
```
36-
$ curl -L -O https://github.com/XPRESSyourself/XPRESSpipe/archive/v0.2.3b0.zip
37-
$ unzip v0.2.3b0.zip
38-
$ cd XPRESSpipe-0.2.3b0/
38+
$ curl -L -O https://github.com/XPRESSyourself/XPRESSpipe/archive/refs/tags/XPRESSpipe-v0.6.3.zip
39+
$ unzip XPRESSpipe-XPRESSpipe-v0.6.3.zip
40+
$ cd XPRESSpipe-XPRESSpipe-v0.6.3/
3941
$ conda env create -f requirements.yml
4042
$ conda activate xpresspipe
41-
$ python setup.py install
43+
$ bash install.sh
4244
$ xpresspipe -h
4345
$ xpresspipe test
4446
```

docs/content/installation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ Install XPRESSpipe
2828
.. code-block:: shell
2929
3030
$ cd ~
31-
$ curl -L -O https://github.com/XPRESSyourself/XPRESSpipe/archive/v0.6.3.tar.gz
32-
$ tar xvzf v0.6.3.tar.gz
33-
$ cd XPRESSpipe-0.6.3
31+
$ curl -L -O https://github.com/XPRESSyourself/XPRESSpipe/archive/refs/tags/XPRESSpipe-v0.6.3.zip
32+
$ unzip XPRESSpipe-XPRESSpipe-v0.6.3.zip
33+
$ cd XPRESSpipe-XPRESSpipe-v0.6.3/
3434
3535
| 3. Install XPRESSpipe dependencies via Conda and activate the XPRESSpipe environment:
3636

0 commit comments

Comments
 (0)