Skip to content

Commit 7f5af91

Browse files
authored
adding sylph version 0.9.0 (#1473)
1 parent 0085b0b commit 7f5af91

File tree

3 files changed

+92
-1
lines changed

3 files changed

+92
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ To learn more about the docker pull rate limits and the open source software pro
325325
| [SRST2](https://hub.docker.com/r/staphb/srst2/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/srst2)](https://hub.docker.com/r/staphb/srst2) | <details><summary>Click to see all versions</summary> <ul><li>[0.2.0](./build-files/srst2/0.2.0/)</li><li>[0.2.0 + custom Vibrio cholerae database](./build-files/srst2/0.2.0-vibrio-230224/README.md)</li></ul> </details> | https://github.com/katholt/srst2 |
326326
| [Staramr](https://hub.docker.com/r/staphb/staramr/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/staramr)](https://hub.docker.com/r/staphb/staramr) | <details><summary>Click to see all versions</summary> <ul><li>[0.5.1](./build-files/staramr/0.5.1/)</li><li>[0.7.1](./build-files/staramr/0.7.1/)</li><li>[0.8.0](./build-files/staramr/0.8.0/)</li><li>[0.10.0](./build-files/staramr/0.10.0/)</li><li>[0.11.0](./build-files/staramr/0.11.0/)</li></ul> </details> | https://github.com/phac-nml/staramr |
327327
| [stxtyper](https://hub.docker.com/r/staphb/stxtyper) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/stxtyper)](https://hub.docker.com/r/staphb/stxtyper) | <details><summary>Click to see all versions</summary> <ul><li>[1.0.24](./build-files/stxtyper/1.0.24/)</li><li>[1.0.27](./build-files/stxtyper/1.0.27/)</li><li>[1.0.31](./build-files/stxtyper/1.0.31/)</li><li>[1.0.40](./build-files/stxtyper/1.0.40/)</li><li>[1.0.42](./build-files/stxtyper/1.0.42/)</li></ul> </details> | https://github.com/ncbi/stxtyper |
328-
| [sylph](https://hub.docker.com/r/staphb/sylph) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/sylph)](https://hub.docker.com/r/staphb/sylph) | <details><summary>Click to see all versions</summary> <ul><li>[0.4.1](./build-files/sylph/0.4.1)</li><li>[0.5.1](./build-files/sylph/0.5.1)</li><li>[0.6.0](./build-files/sylph/0.6.0)</li><li>[0.6.1](./build-files/sylph/0.6.1)</li><li>[0.8.0](./build-files/sylph/0.8.0)</li>[0.8.1](./build-files/sylph/0.8.1/)<li></li></ul> </details> | https://github.com/bluenote-1577/sylph |
328+
| [sylph](https://hub.docker.com/r/staphb/sylph) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/sylph)](https://hub.docker.com/r/staphb/sylph) | <details><summary>Click to see all versions</summary> <ul><li>[0.4.1](./build-files/sylph/0.4.1)</li><li>[0.5.1](./build-files/sylph/0.5.1)</li><li>[0.6.0](./build-files/sylph/0.6.0/)</li><li>[0.6.1](./build-files/sylph/0.6.1)</li><li>[0.8.0](./build-files/sylph/0.8.0)</li><li>[0.8.1](./build-files/sylph/0.8.1/)</li><li>[0.9.0](./build-files/sylph/0.9.0/)</li></ul> </details> | https://github.com/bluenote-1577/sylph |
329329
| [TBProfiler](https://hub.docker.com/r/staphb/tbprofiler/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/tbprofiler)](https://hub.docker.com/r/staphb/tbprofiler) | <details><summary>Click to see all versions</summary> <ul><li>[4.3.0](./build-files/tbprofiler/4.3.0/)</li><li>[4.4.0](./build-files/tbprofiler/4.4.0/)</li><li>[4.4.2](./build-files/tbprofiler/4.4.2/)</li><li>[5.0.1](./build-files/tbprofiler/5.0.1/)</li><li>[6.2.0](./build-files/tbprofiler/6.2.0/)</li><li>[6.2.1](./build-files/tbprofiler/6.2.1/)</li><li>[6.3.0](./build-files/tbprofiler/6.3.0/)</li><li>[6.4.0](./build-files/tbprofiler/6.4.0/)</li><li>[6.4.1](./build-files/tbprofiler/6.4.1/)</li><li>[6.6.2](./build-files/tbprofiler/6.6.2/)</li><li>[6.6.3](./build-files/tbprofiler/6.6.3/)</li><li>[6.6.5](./build-files/tbprofiler/6.6.5/)</li></ul> </details> | https://github.com/jodyphelan/TBProfiler <br/> https://github.com/jodyphelan/tbdb |
330330
| [TipToft](https://hub.docker.com/r/staphb/tiptoft/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/tiptoft)](https://hub.docker.com/r/staphb/tiptoft) | <details><summary>Click to see all versions</summary> <ul><li>[1.0.0](./build-files/tiptoft/1.0.0/)</li><li>[1.0.2](./build-files/tiptoft/1.0.2/)</li></ul> </details> | https://github.com/andrewjpage/tiptoft |
331331
| [Tostadas](https://hub.docker.com/r/staphb/tostadas/) <br/> [![docker pulls](https://badgen.net/docker/pulls/staphb/tostadas)](https://hub.docker.com/r/staphb/tostadas) | <details><summary>Click to see all versions</summary> <ul><li>[0.2.0-beta](./build-files/tostadas/0.2.0-beta/)</li><li>[3.1.0](./build-files/tostadas/3.1.0/)</li><li>[4.0.0](./build-files/tostadas/4.0.0/)</li></ul> </details> | https://github.com/CDCgov/tostadas |

build-files/sylph/0.9.0/Dockerfile

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
ARG SYLPH_VER="0.9.0"
2+
3+
## Builder ##
4+
FROM rust:1.90 AS builder
5+
6+
ARG SYLPH_VER
7+
8+
RUN apt update && \
9+
apt install -y cmake && \
10+
wget -q https://github.com/bluenote-1577/sylph/archive/refs/tags/v${SYLPH_VER}.tar.gz && \
11+
tar -xvf v${SYLPH_VER}.tar.gz && \
12+
cd sylph-${SYLPH_VER} && \
13+
cargo install --path . --root ~/.cargo && \
14+
chmod +x /root/.cargo/bin/sylph
15+
16+
## App ##
17+
FROM ubuntu:jammy AS app
18+
19+
ARG SYLPH_VER
20+
21+
LABEL base.image="ubuntu:jammy"
22+
LABEL dockerfile.version="1"
23+
LABEL software="sylph"
24+
LABEL software.version=${SYLPH_VER}
25+
LABEL description="sylph is a program that can perform ultrafast (1) ANI querying or (2) metagenomic profiling for metagenomic shotgun samples."
26+
LABEL website="https://github.com/bluenote-1577/sylph"
27+
LABEL license="https://github.com/bluenote-1577/sylph/blob/main/LICENSE"
28+
LABEL maintainer="Stephen Turner"
29+
LABEL maintainer.email="vustephen@gmail.com"
30+
31+
# copy app from builder stage
32+
COPY --from=builder /root/.cargo/bin/sylph /usr/local/bin/sylph
33+
34+
# default run command
35+
CMD ["sylph", "-h"]
36+
37+
# singularity compatibility
38+
ENV LC_ALL=C
39+
40+
# final working directory in app layer is /data
41+
WORKDIR /data
42+
43+
## Test ##
44+
FROM app AS test
45+
46+
# making sure sylph is in PATH
47+
RUN sylph -h
48+
49+
ARG SYLPH_VER
50+
51+
RUN apt update && apt install -y wget
52+
53+
WORKDIR /test
54+
55+
COPY --from=builder /sylph-${SYLPH_VER}/test_files/* /test
56+
57+
RUN date && \
58+
sylph sketch -i e.coli-*.fasta.gz -o database && \
59+
sylph sketch o157_reads.fastq.gz && \
60+
sylph query database.syldb *.sylsp > ani_queries.tsv && \
61+
sylph profile database.syldb *.sylsp > profiling.tsv && \
62+
cat *.tsv && \
63+
date

build-files/sylph/0.9.0/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# sylph container
2+
3+
Main tool : [sylph](https://github.com/bluenote-1577/sylph)
4+
5+
Full documentation: https://github.com/bluenote-1577/sylph/wiki
6+
7+
sylph is a program that can perform ultrafast (1) ANI querying or (2) metagenomic profiling for metagenomic shotgun samples.
8+
9+
## Example Usage
10+
11+
```bash
12+
# all fasta -> one *.syldb; fasta are assumed to be genomes
13+
sylph sketch genome1.fa genome2.fa -o database
14+
#EQUIVALENT: sylph sketch -g genome1.fa genome2.fa -o database
15+
16+
# multi-sample sketching of paired reads
17+
sylph sketch -1 A_1.fq B_1.fq -2 A_2.fq B_2.fq -d output_read_sketch_folder
18+
19+
# multi-sample sketching for single end reads, fastq are assumed to be reads
20+
sylph sketch reads.fq
21+
#EQUIVALENT: sylph sketch -r reads.fq
22+
23+
# ANI querying
24+
sylph query database.syldb *.sylsp -t (threads) > ani_queries.tsv
25+
26+
# taxonomic profiling
27+
sylph profile database.syldb *.sylsp -t (threads) > profiling.tsv
28+
```

0 commit comments

Comments
 (0)