Thanks for your interest in genome-sampler!

This page is main entry point into the genome-sampler documentation. After reading this documentation, you’ll know how to install and use genome-sampler and where to turn if you need help.

Getting started with genome-sampler¶

Installation instructions for genome-sampler are available in our Installation.

To learn how to use genome-sampler you can work through our Step-by-step tutorial after installing or refer to the Plugin Overview.

Getting help¶

If you need technical support, please post a question to the QIIME 2 Forum.

If genome-sampler is missing a feature that would be helpful for your work, please post to the GitHub issue tracker.

Licensing and source code¶

genome-sampler is open-source and free for all use, including commercial. Software and unit tests are available in our GitHub repository under the BSD 3-clause license.

About genome-sampler¶

genome-sampler is built on the QIIME 2 Framework (Q2F). Q2F offers useful features for bioinformatics software, including that it ensures reproducible bioinformatics and is accessible through different types of interfaces. Learn more about the QIIME 2 Framework (Q2F) at https://qiime2.org.

genome-sampler’s documentation is written using Myst and rendered using Jupyter Book 2.

genome-sampler is primarily developed in the Caporaso Lab at Northern Arizona University.

Citing genome-sampler¶

If you use genome-sampler in published work, we ask that you cite our paper Bolyen et al., 2020.

The primary workflow implemented in genome-sampler also makes extensive use of vsearch Rognes et al., 2016, so you should also cite that in your published work.

If you use other components of QIIME 2 (as discussed in ) you may end up using other tools that need to be cited. If you load a .qza or .qzv file with QIIME 2 View, you can obtain a list of the papers you should cite under the Details tab in Bibtex format.