Skip to main content

Microbial diversity analysis toolkit

Project description

qdiv: Microbial Diversity Analysis Toolkit

qdiv is a Python toolkit for microbial diversity analysis, built around the robust and intuitive Hill number framework.


Features

  • Data Management: Load and validate data from multiple formats (CSV/TSV, FASTA, Newick). Functions for subsetting, rarefaction, merging, renaming, tree pruning, and more.

  • Diversity analysis: Compute multiple alpha and beta diversity metrics based on the Hill number framework.

  • Statistical methods: Integrate diversity metrics using the Hill number framework into null models (Raup–Crick, NRI, NTI), ordinations (PCoA, db-RDA), PERMANOVA, and Mantel tests.

  • Visualization: Heatmaps, ordinations, and diversity plots, and more.


Installation

pip install qdiv

Optional acceleration (Numba)

Some functions in the sequence_comparisons module support compilation via Numba. Installing qdiv with the optional accelerate extra enables faster sequence distance computations.

pip install qdiv[accelerate]

Documentation

Full documentation is available at: https://qdiv.readthedocs.io


Licence

From version 4.0.0, qdiv is licensed under the https://opensource.org/licenses/BSD-3-Clause. Previous versions were released under the GNU General Public License v3.0 (GPL-3.0).

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md for details on:

  • How to report bugs
  • How to request new features
  • How to submit pull requests

Support

If you need help with qdiv:

  • Browse existing issues
  • If needed, open a support issue. See SUPPORT.md.

Code of Conduct

To ensure a welcoming environment, this project follows the standards outlined in the CODE_OF_CONDUCT.md. All contributors are expected to uphold this code.

Citation

If you use qdiv in your research, please cite:

Modin. (2026). qdiv: A Python package for microbial ecology analysis using the Hill number framework. Journal of Open Source Software, 11(121), 10089. https://doi.org/10.21105/joss.10089.

Download the citation here:

CITATION.cff

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qdiv-4.0.5.tar.gz (673.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qdiv-4.0.5-py3-none-any.whl (703.6 kB view details)

Uploaded Python 3

File details

Details for the file qdiv-4.0.5.tar.gz.

File metadata

  • Download URL: qdiv-4.0.5.tar.gz
  • Upload date:
  • Size: 673.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for qdiv-4.0.5.tar.gz
Algorithm Hash digest
SHA256 b691839857a81eb6d479bab4b6e3dc12c5cd6d1550a87ad4208add0b8d335c3d
MD5 3b630b8b221b20858272b03eba42ad56
BLAKE2b-256 fa6ec1f2bf36f1e1ed496ef408ed9db98f7cb9a10a19da784d0c705e1a930691

See more details on using hashes here.

File details

Details for the file qdiv-4.0.5-py3-none-any.whl.

File metadata

  • Download URL: qdiv-4.0.5-py3-none-any.whl
  • Upload date:
  • Size: 703.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for qdiv-4.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a6633b04b22c0665d49e41179ce3fc0eecd4bcf45d597f707f28ffd3d5e2759e
MD5 bf7dc1a6205d1b36a886bfb1b44e811c
BLAKE2b-256 74ff074592fd0b1ce6514b18ec5d0e399c4cde373cddcdcb698e8bc0dfaf8ea3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page