diff --git a/.github/workflows/update_freyja.yml b/.github/workflows/update_freyja.yml index 08f1445aa..054cdd6d4 100644 --- a/.github/workflows/update_freyja.yml +++ b/.github/workflows/update_freyja.yml @@ -9,7 +9,7 @@ name: Update Freyja on: workflow_dispatch: schedule: - - cron: '30 7 * * *' + - cron: '30 7 1 * *' run-name: Updating Freyja diff --git a/.gitpod.yml b/.gitpod.yml index e5a3bb083..d1709bab7 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -10,7 +10,7 @@ tasks: pip install graphviz . /opt/conda/etc/profile.d/conda.sh conda activate base - git checkout main + git checkout master vscode: extensions: # based on nf-core.nf-core-extensionpack - codezombiech.gitignore # Language support for .gitignore files diff --git a/Program_Licenses.md b/Program_Licenses.md index 15586a21c..8bb262fe0 100644 --- a/Program_Licenses.md +++ b/Program_Licenses.md @@ -19,7 +19,7 @@ The licenses of the open-source software that is contained in these Docker image | Bakta | GNU GPLv3 | https://github.com/oschwengers/bakta/blob/main/LICENSE | | Bandage | GNU GPLv3 | https://github.com/rrwick/Bandage?tab=GPL-3.0-1-ov-file#readme | | BBTools | non-standard - see `licence.txt` and `legal.txt` that is included in docker image under `/bbmap/docs/`; Also on sourceforge repo for BBTools | https://jgi.doe.gov/disclaimer/ | -| bcftools | MIT or **GNU GPLv3** (depends on how bcftools was compiled, I believe GNU GPLv3 applies here) | https://github.com/samtools/bcftools/blob/develop/LICENSE | +| bcftools | MIT & **GNU GPLv3** | https://github.com/samtools/bcftools/blob/develop/LICENSE | | bedtools | MIT | https://github.com/arq5x/bedtools2/blob/master/LICENSE | | blast+ | Public Domain | https://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/lxr/source/scripts/projects/blast/LICENSE | | bowtie2 | GNU GPLv3 | https://github.com/BenLangmead/bowtie2/blob/master/LICENSE | @@ -60,6 +60,7 @@ The licenses of the open-source software that is contained in these Docker image | Freyja | BSD-2 | https://github.com/andersen-lab/Freyja/blob/main/LICENSE | | GAMBIT | GNU aGPLv3 | https://github.com/jlumpe/gambit/blob/master/LICENSE | | GAMMA | Apache 2.0 | https://github.com/rastanton/GAMMA/blob/main/LICENSE | +| GenoFlu | GNU GPL v3 | https://github.com/USDA-VS/GenoFLU/blob/main/LICENSE | | Genotyphi | GNU GPLv3 | https://github.com/katholt/genotyphi/blob/main/LICENSE | | geNomad | ACADEMIC, INTERNAL, RESEARCH & DEVELOPMENT, NON-COMMERCIAL USE ONLY | https://github.com/apcamargo/genomad/blob/main/LICENSE | | GenoVi | BY-NC-SA Creative Commons License | https://github.com/robotoD/GenoVi/blob/main/LICENSE.txt | @@ -113,7 +114,9 @@ The licenses of the open-source software that is contained in these Docker image | ONTime | MIT | https://github.com/mbhall88/ontime/blob/main/LICENSE | | OrthoFinder | GNU GPLv3 | https://github.com/davidemms/OrthoFinder/blob/master/License.md | | Panaroo | MIT | https://github.com/gtonkinhill/panaroo/blob/master/LICENSE | +| pango_aliasor | MIT | https://github.com/corneliusroemer/pango_aliasor/blob/main/LICENSE | | Pangolin | GNU GPLv3 | https://github.com/cov-lineages/pangolin/blob/master/LICENSE.txt | +| panqc | MIT | https://github.com/maxgmarin/panqc/blob/main/LICENSE | | Parsnp | Battelle National Biodefense Institute (BNBI) | https://github.com/marbl/parsnp?tab=License-1-ov-file#readme | | pasty | Apache 2.0 | https://github.com/rpetit3/pasty/blob/main/LICENSE | | Pavian | GNU GPLv3 | https://github.com/fbreitwieser/pavian/blob/master/DESCRIPTION | @@ -143,6 +146,7 @@ The licenses of the open-source software that is contained in these Docker image | raven | MIT | https://github.com/lbcb-sci/raven/blob/master/LICENSE | | RAxML | GNU GPLv3 | https://github.com/stamatak/standard-RAxML/blob/master/gpl-3.0.txt | | RAxML-NG | GNU AGPLv3| https://github.com/amkozlov/raxml-ng/blob/master/LICENSE.txt | +| RAxML-NG | GNU GPLv2 | https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html | | ResFinder | Apache 2.0 | https://bitbucket.org/genomicepidemiology/resfinder/src/master/ | | Roary | GNU GPLv3 | https://github.com/sanger-pathogens/Roary/blob/master/GPL-LICENSE | | SalmID| MIT | https://github.com/hcdenbakker/SalmID/blob/master/LICENSE | @@ -155,6 +159,7 @@ The licenses of the open-source software that is contained in these Docker image | seqtk | MIT | https://github.com/lh3/seqtk/blob/master/LICENSE | | Seroba | GNU GPLv3 | https://github.com/sanger-pathogens/seroba/blob/master/LICENSE | | SerotypeFinder | Apache 2.0 | https://bitbucket.org/genomicepidemiology/serotypefinder/ | +| ShigaPass | GNU GPLv3 | https://github.com/imanyass/ShigaPass/blob/main/LICENSE | | shigatyper | non-standard license see --> | https://github.com/CFSAN-Biostatistics/shigatyper/blob/master/LICENSE | | ShigEiFinder | GNU GPLv3 | https://github.com/LanLab/ShigEiFinder/blob/main/LICENSE | | Shovill | GNU GPLv3 | https://github.com/tseemann/shovill/blob/master/LICENSE | @@ -173,6 +178,7 @@ The licenses of the open-source software that is contained in these Docker image | SRA-toolkit | Public Domain | https://github.com/ncbi/sra-tools/blob/master/LICENSE | | SRST2 | BSD | https://github.com/katholt/srst2/blob/master/LICENSE.txt | | Staramr | Apache 2.0 | https://github.com/phac-nml/staramr/blob/master/LICENSE | +| stxtyper | Public Domain | https://github.com/ncbi/stxtyper/blob/main/LICENSE | | sylph | MIT | https://github.com/bluenote-1577/sylph/blob/main/LICENSE | | TBProfiler | GNU GPLv3 | https://github.com/jodyphelan/TBProfiler/blob/master/LICENSE | | TipToft | GNU GPLv3 | https://github.com/andrewjpage/tiptoft/blob/master/LICENSE | @@ -185,6 +191,7 @@ The licenses of the open-source software that is contained in these Docker image | Verkko | Public Domain | https://github.com/marbl/verkko/blob/master/README.licenses | | VIBRANT | GNU GPLv3 | https://github.com/AnantharamanLab/VIBRANT/blob/master/LICENSE | | VIGOR4 | GNU GPLv3 | https://github.com/JCVenterInstitute/VIGOR4/blob/master/LICENSE.txt | +| Viridian | MIT | https://github.com/iqbal-lab-org/viridian/blob/master/LICENSE | | VirSorter2 | GNU GPLv2 | https://github.com/jiarong/VirSorter2/blob/master/LICENSE | | VirulenceFinder | Apache 2.0 | https://bitbucket.org/genomicepidemiology/virulencefinder/src/master/ | | wtdbg2 | GNU GPLv3 | https://github.com/ruanjue/wtdbg2/blob/master/LICENSE.txt | diff --git a/README.md b/README.md index 963e43320..dfb39158e 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,11 @@ singularity exec --bind $(pwd)/fastq:/data staphb-bbtools-38.96.simg bbduk.sh in Further documentation can be found at [docs.sylabs.io](https://docs.sylabs.io/guides/3.1/user-guide/cli.html) +## Training + +- Training materials (slides & exercises) from the North East Bioinformatics Regional Resource 2023 workshop **Docker for Public Health Bioinformatics** can be located here, within [`training/NE-BRR-docker-for-PH-bioinformatics-May2023/`](training/NE-BRR-docker-for-PH-bioinformatics-May2023/) +- Video training from APHL 2024 workshop **Intermediate Docker Bioinformatics Workshop** can be located in [APHL's e-learning resources](https://learn.aphl.org/learn/course/external/view/elearning/355/intermediate-docker-bioinformatics-workshop) + ## Logs In November 2020, Docker began to implement pull rate limits for images hosted on dockerhub. This limits the number of `docker pull`'s per time period (e.g. anonymous users allowed 100 pulls per six hours). We applied and were approved for Docker's "Open Source Program," which should have removed the pull rate limits for all `staphb` docker images! 🎉 🥳 If you encounter an error such as `ERROR: toomanyrequests: Too Many Requests.` or `You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limits.` , please let us know by [submitting an issue.](https://github.com/StaPH-B/docker-builds/issues) @@ -106,7 +111,7 @@ To learn more about the docker pull rate limits and the open source software pro | :--------: | ------- | -------- | | [ABRicate](https://hub.docker.com/r/staphb/abricate/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/abricate)](https://hub.docker.com/r/staphb/abricate) | | https://github.com/tseemann/abricate | | [ACI](https://hub.docker.com/r/staphb/aci/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/aci)](https://hub.docker.com/r/staphb/aci) | | https://github.com/erinyoung/ACI | -| [ANIclustermap](https://hub.docker.com/r/staphb/aniclustermap/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/aniclustermap)](https://hub.docker.com/r/staphb/aniclustermap) | | https://github.com/moshi4/ANIclustermap | +| [ANIclustermap](https://hub.docker.com/r/staphb/aniclustermap/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/aniclustermap)](https://hub.docker.com/r/staphb/aniclustermap) | | https://github.com/moshi4/ANIclustermap | | [any2fasta](https://hub.docker.com/r/staphb/any2fasta/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/any2fasta)](https://hub.docker.com/r/staphb/any2fasta) | | https://github.com/tseemann/any2fasta | | [ARIBA](https://hub.docker.com/r/staphb/ariba/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/ariba)](https://hub.docker.com/r/staphb/ariba) | | https://github.com/sanger-pathogens/ariba | | [artic](https://hub.docker.com/r/staphb/artic)
[![docker pulls](https://badgen.net/docker/pulls/staphb/artic)](https://hub.docker.com/r/staphb/artic) | | https://github.com/artic-network/fieldbioinformatics | @@ -115,16 +120,16 @@ To learn more about the docker pull rate limits and the open source software pro | [artic-ncov2019-medaka](https://hub.docker.com/r/staphb/artic-ncov2019-medaka)
[![docker pulls](https://badgen.net/docker/pulls/staphb/artic-ncov2019-medaka)](https://hub.docker.com/r/staphb/artic-ncov2019-medaka) | | https://github.com/artic-network/artic-ncov2019 | | [artic-ncov2019-nanopolish](https://hub.docker.com/r/staphb/artic-ncov2019-nanopolish)
[![docker pulls](https://badgen.net/docker/pulls/staphb/artic-ncov2019-nanopolish)](https://hub.docker.com/r/staphb/artic-ncov2019-nanopolish) | | https://github.com/artic-network/artic-ncov2019 | | [assembly_snptyper](https://hub.docker.com/r/staphb/assembly_snptyperh)
[![docker pulls](https://badgen.net/docker/pulls/staphb/assembly_snptyper)](https://hub.docker.com/r/staphb/assembly_snptyper) | | https://github.com/boasvdp/assembly_snptyper | -| [Augur](https://hub.docker.com/r/staphb/augur)
[![docker pulls](https://badgen.net/docker/pulls/staphb/augur)](https://hub.docker.com/r/staphb/augur) | | https://github.com/nextstrain/augur | +| [Augur](https://hub.docker.com/r/staphb/augur)
[![docker pulls](https://badgen.net/docker/pulls/staphb/augur)](https://hub.docker.com/r/staphb/augur) | | https://github.com/nextstrain/augur | | [Auspice](https://hub.docker.com/r/staphb/auspice)
[![docker pulls](https://badgen.net/docker/pulls/staphb/auspice)](https://hub.docker.com/r/staphb/auspice) | | https://github.com/nextstrain/auspice | -| [bakta](https://hub.docker.com/r/staphb/bakta)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bakta)](https://hub.docker.com/r/staphb/bakta) | | https://github.com/oschwengers/bakta | +| [bakta](https://hub.docker.com/r/staphb/bakta)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bakta)](https://hub.docker.com/r/staphb/bakta) | | https://github.com/oschwengers/bakta | | [bandage](https://hub.docker.com/r/staphb/bandage)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bandage)](https://hub.docker.com/r/staphb/bandage) | | https://rrwick.github.io/Bandage/ | | [BBTools](https://hub.docker.com/r/staphb/bbtools/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bbtools)](https://hub.docker.com/r/staphb/bbtools) | | https://jgi.doe.gov/data-and-tools/bbtools/ | -| [bcftools](https://hub.docker.com/r/staphb/bcftools/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bcftools)](https://hub.docker.com/r/staphb/bcftools) | | https://github.com/samtools/bcftools | +| [bcftools](https://hub.docker.com/r/staphb/bcftools/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bcftools)](https://hub.docker.com/r/staphb/bcftools) | | https://github.com/samtools/bcftools | | [bedtools](https://hub.docker.com/r/staphb/bedtools/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bedtools)](https://hub.docker.com/r/staphb/bedtools) | | https://bedtools.readthedocs.io/en/latest/
https://github.com/arq5x/bedtools2 | | [berrywood-report-env](https://hub.docker.com/r/staphb/berrywood-report-env/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/berrywood-report-env)](https://hub.docker.com/r/staphb/berrywood-report-env) | | none | -| [blast+](https://hub.docker.com/r/staphb/blast/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/blast)](https://hub.docker.com/r/staphb/blast) | | https://www.ncbi.nlm.nih.gov/books/NBK279690/ | -| [bowtie2](https://hub.docker.com/r/staphb/bowtie2/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bowtie2)](https://hub.docker.com/r/staphb/bowtie2) | | http://bowtie-bio.sourceforge.net/bowtie2/manual.shtml
https://github.com/BenLangmead/bowtie2 | +| [blast+](https://hub.docker.com/r/staphb/blast/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/blast)](https://hub.docker.com/r/staphb/blast) | | https://www.ncbi.nlm.nih.gov/books/NBK279690/ | +| [bowtie2](https://hub.docker.com/r/staphb/bowtie2/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bowtie2)](https://hub.docker.com/r/staphb/bowtie2) | | http://bowtie-bio.sourceforge.net/bowtie2/manual.shtml
https://github.com/BenLangmead/bowtie2 | | [Bracken](https://hub.docker.com/r/staphb/bracken/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bracken)](https://hub.docker.com/r/staphb/bracken) | | https://ccb.jhu.edu/software/bracken/index.shtml?t=manual
https://github.com/jenniferlu717/Bracken | | [BUSCO](https://hub.docker.com/r/staphb/busco/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/busco)](https://hub.docker.com/r/staphb/busco) | | https://busco.ezlab.org/busco_userguide.html
https://gitlab.com/ezlab/busco | | [BWA](https://hub.docker.com/r/staphb/bwa)
[![docker pulls](https://badgen.net/docker/pulls/staphb/bwa)](https://hub.docker.com/r/staphb/bwa) | | https://github.com/lh3/bwa | @@ -133,21 +138,21 @@ To learn more about the docker pull rate limits and the open source software pro | [centroid](https://hub.docker.com/r/staphb/centroid/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/centroid)](https://hub.docker.com/r/staphb/centroid) | | https://github.com/stjacqrm/centroid | | [CDC-SPN](https://hub.docker.com/r/staphb/cdc-spn/)
[![docker pulls](https://badgen.net/docker/pulls/staphb/cdc-spn)](https://hub.docker.com/r/staphb/cdc-spn) | | https://github.com/BenJamesMetcalf/Spn_Scripts_Reference | | [cfsan-snp-pipeline](https://hub.docker.com/r/staphb/cfsan-snp-pipeline)
[![docker pulls](https://badgen.net/docker/pulls/staphb/cfsan-snp-pipeline)](https://hub.docker.com/r/staphb/cfsan-snp-pipeline) | | https://github.com/CFSAN-Biostatistics/snp-pipeline | -| [CheckM](https://hub.docker.com/r/staphb/checkm)
[![docker pulls](https://badgen.net/docker/pulls/staphb/checkm)](https://hub.docker.com/r/staphb/checkm) | | https://github.com/Ecogenomics/CheckM | +| [CheckM](https://hub.docker.com/r/staphb/checkm)
[![docker pulls](https://badgen.net/docker/pulls/staphb/checkm)](https://hub.docker.com/r/staphb/checkm) | | https://github.com/Ecogenomics/CheckM | | [Circlator](https://hub.docker.com/r/staphb/circlator)
[![docker pulls](https://badgen.net/docker/pulls/staphb/circlator)](https://hub.docker.com/r/staphb/circlator) | | https://github.com/sanger-pathogens/circlator | | [Circos](https://hub.docker.com/r/staphb/circos)
[![docker pulls](https://badgen.net/docker/pulls/staphb/circos)](https://hub.docker.com/r/staphb/circos) | | https://circos.ca/ | | [CirculoCov](https://hub.docker.com/r/staphb/circulocov)
[![docker pulls](https://badgen.net/docker/pulls/staphb/circulocov)](https://hub.docker.com/r/staphb/circulocov) | | https://github.com/erinyoung/CirculoCov | -| [Clair3](https://hub.docker.com/r/staphb/clair3)
[![docker pulls](https://badgen.net/docker/pulls/staphb/clair3)](https://hub.docker.com/r/staphb/clair3) | | https://github.com/HKU-BAL/Clair3 | +| [Clair3](https://hub.docker.com/r/staphb/clair3)
[![docker pulls](https://badgen.net/docker/pulls/staphb/clair3)](https://hub.docker.com/r/staphb/clair3) | | https://github.com/HKU-BAL/Clair3 | | [Clustalo](https://hub.docker.com/r/staphb/clustalo)
[![docker pulls](https://badgen.net/docker/pulls/staphb/clustalo)](https://hub.docker.com/r/staphb/clustalo) | | http://www.clustal.org/omega/ | | [colorid](https://hub.docker.com/r/staphb/colorid)
[![docker pulls](https://badgen.net/docker/pulls/staphb/colorid)](https://hub.docker.com/r/staphb/colorid) | | https://github.com/hcdenbakker/colorid | | [cutshaw-report-env](https://hub.docker.com/r/staphb/cutshaw-report-env)
[![docker pulls](https://badgen.net/docker/pulls/staphb/cutshaw-report-env)](https://hub.docker.com/r/staphb/cutshaw-report-env) | | https://github.com/VADGS/CutShaw | | [datasets-sars-cov-2](https://github.com/CDCgov/datasets-sars-cov-2)
[![docker pulls](https://badgen.net/docker/pulls/staphb/datasets-sars-cov-2)](https://hub.docker.com/r/staphb/datasets-sars-cov-2) | | https://github.com/CDCgov/datasets-sars-cov-2 | | [diamond](https://github.com/bbuchfink/diamond)
[![docker pulls](https://badgen.net/docker/pulls/staphb/diamond)](https://hub.docker.com/r/staphb/diamond) | | https://github.com/bbuchfink/diamond| -| [dnaapler](https://hub.docker.com/r/staphb/dnaapler)
[![docker pulls](https://badgen.net/docker/pulls/staphb/dnaapler)](https://hub.docker.com/r/staphb/dnaapler) | | https://github.com/gbouras13/dnaapler | +| [dnaapler](https://hub.docker.com/r/staphb/dnaapler)
[![docker pulls](https://badgen.net/docker/pulls/staphb/dnaapler)](https://hub.docker.com/r/staphb/dnaapler) | | https://github.com/gbouras13/dnaapler | | [dragonflye](https://hub.docker.com/r/staphb/dragonflye)
[![docker pulls](https://badgen.net/docker/pulls/staphb/dragonflye)](https://hub.docker.com/r/staphb/dragonflye) | | https://github.com/rpetit3/dragonflye | | [Dr. PRG ](https://hub.docker.com/r/staphb/drprg)
[![docker pulls](https://badgen.net/docker/pulls/staphb/drprg)](https://hub.docker.com/r/staphb/drprg) | | https://mbh.sh/drprg/ | -| [DSK](https://hub.docker.com/r/staphb/dsk)
[![docker pulls](https://badgen.net/docker/pulls/staphb/dsk)](https://hub.docker.com/r/staphb/dsk) |