Acanthophis
A reusable, comprehensive, opinionated Snakemake pipeline for plant-microbe genomics and plant variant calling.
Documentation
For documentation, see ./documentation.md. In summary:
# create conda env, activate it
mamba create -n someproject python snakemake pip natsort
mamba activate someproject
# Install acanthophis itself
pip install acanthophis
# Generate a workspace. This copies all files the workflow will need to your
# workspace directory.
acanthophis-init /path/to/someproject/
# Edit config.yml to suit your project. Hopefully this config file documents
# all options available in an understandable fashion. If not, please raise an
# issue on github.
vim config.yml
# Run snakemake
snakemake -j 16 -p --use-conda --conda-frontend mamba --ri
# Or on a cluster, see acanthophis-init --list-available-profiles
snakemake --profile ./ebio-cluster/
Compatibility
While snakemake and Acanthophis are cross-platform, most of the underlying tools are only packaged for and/or only operate on Linux x68_64. Therefore, I only support users on Linux systems. In theory, everything should run on OSX or WSL, but the vast majority of users will want to utilise a high performance linux workstation (at least, probably more likely a cluster).
Running tests
For running tests, see ./tests/README.md.
Contribution & Assistance
If you have anything (advice, docs, code) you'd like to contribute, pull requests are more than welcome. Please discuss any major contribution in a new issue before implementing it, to avoid wasted effort.
If you need any assistance, or have other questions or comments, please make an issue on github, or open a discussion. Unfortunately both need an account on github, so alternatively you can email me (foss <usual email symbol> kdmurray.id.au).
About & Authors
This is an amalgamation of several pipelines developed between the Weigel Group, MPI DB, Tübingen, DE, the Warthmann Group, IAEA/FAO PBGL, Seibersdorf, AT and the Borevitz Group, ANU, Canberra, AU. This amalgamation authored by Dr. K. D. Murray, original code primary by K. D. Murray, Norman Warthmann, with contributions from others at the aforementioned institutes.
1 maintainer
Metadata
1 maintainer
Release files for acanthophis 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| acanthophis-1.1.0.tar.gz | 320.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| acanthophis-1.1.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 391.7 kB
Release files / acanthophis-1.1.0.tar.gz
| Download URL | acanthophis-1.1.0.tar.gz |
|---|---|
| Size | 320.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5ae5896eb60211d114d1ecc16419c47459d4b622b31f00d57567879e06d9a2b6
|
|
BLAKE2b-256 checksum How to use checksums |
fbf5b1ed24e19a568e81312a8e42802afd8000e3b067b6b71f10ab1d6dc7e8cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
Release files / acanthophis-1.1.0-py2.py3-none-any.whl
| Download URL | acanthophis-1.1.0-py2.py3-none-any.whl |
|---|---|
| Size | 71.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
577010ff4aa75a809d91c1680c6c0e6684e08dbe8ef043a07f7c2f422987ae36
|
|
BLAKE2b-256 checksum How to use checksums |
69543d53ecee699bd10e3300cf11190520ff2708bbcf4e64d51783f6f8652ea4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
Security for acanthophis 1.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
