Skip to content

Commit

Permalink
fixed the docker documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jennifer Chang committed Aug 9, 2018
1 parent 378083f commit f2be24c
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,28 @@ You should replace `~/bin/smof` with some folder that is in PATH.

`smof` also requires `python3` be in PATH, you can check with `which python3`.

Docker
=========
##Docker
Install from DockerHub, by pulling the image.

```
docker pull incertaesedis/smof
```

Open and run the image.

```
# Run interactively
docker run -it smof:latest sh
docker run -it incertaesedis/smof:latest sh
# Mount data and call smof
docker run -v ${PWD}:/inout/ smof:latest /smof
# Mount data as a volume (inout) and call smof
docker run -v ${PWD}:/inout/ incertaesedis/smof:latest smof
```

Navigate to the folder containing your fasta file and run smof.

# Example
docker run -v ${PWD}:/inout/ smof:latest /smof grep Iowa fasta.fa Iowa.fa
```
# Example smof command
docker run -v ${PWD}:/inout/ incertaesedis/smof:latest smof grep Iowa fasta.fa > Iowa.fa
```

Functions
Expand Down

0 comments on commit f2be24c

Please sign in to comment.