Skip to content

Commit

Permalink
update install for conda
Browse files Browse the repository at this point in the history
  • Loading branch information
holtjma committed May 17, 2023
1 parent 93222af commit 3c48a39
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
# Installing HiPhase
## Instructions
## From conda
The easiest way to install HiPhase is through [conda](https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html):

```bash
# create a brand new conda environment and install latest HiPhase
conda create -n hiphase -c bioconda hiphase
# OR install latest into current conda environment
conda install hiphase
# OR install a specific version into current conda environment
conda install hiphase=0.8.1
```

## From GitHub
Conda updates usually lag the GitHub release by a couple days.
Use the following instructions to get the most recent version directly from GitHub:

1. Navigate to the [latest release](https://github.com/PacificBiosciences/HiPhase/releases/latest) and download the tarball file (e.g. `hiphase-{version}-x86_64-unknown-linux-gnu.tar.gz`).
2. Decompress the tar file.
3. (Optional) Verify the md5 checksum.
4. Test the binary file by running it with the help option (`-h`).
5. Visit the [User guide](./user_guide.md) for details on running HiPhase.

## Example with v0.7.2
### Example with v0.7.2
```bash
# modify this to update the version
VERSION="v0.7.2"
Expand Down

0 comments on commit 3c48a39

Please sign in to comment.