Skip to content

Commit

Permalink
docs container
Browse files Browse the repository at this point in the history
  • Loading branch information
gbouras13 committed Sep 26, 2024
1 parent bf866b8 commit 49f6adf
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,28 @@ pip install pharokka

You will still need to install the non-python dependencies manually.

## Container

If you have Docker/Singularity/Apptainer installed, you can use the [biocontainers container](https://quay.io/repository/biocontainers/pharokka?tab=tags) (yes, every bioconda package has one!)

You might find this useful if you have trouble with conda environments.

For example to install `pharokka v1.7.3` with Singularity:

```
IMAGE_DIR="<the directory you want the .sif file to be in >"
# e.g. to pull into the working directory
IMAGE_DIR=$PWD
singularity pull --dir $IMAGE_DIR docker://quay.io/biocontainers/pharokka:1.7.3--pyhdfd78af_0
```

* Then to run, you use the same commands but prepended with `singularity exec <.sif file>` e.g.:

```
containerImage="$IMAGE_DIR/pharokka_1.7.3--pyhdfd78af_0.sif"
singularity exec $containerImage pharokka.py -h
```

## Source

Alternatively, the development version of `pharokka` (which may include new, untested features) can be installed manually via github.
Expand Down

0 comments on commit 49f6adf

Please sign in to comment.