Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MRG: docs: add branchwater reference; make FAQ more visible #2984

Merged
merged 4 commits into from Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/faq.md
Expand Up @@ -302,3 +302,6 @@ lot of new k-mers that pop up with a longer k-mer size (e.g. because
of included variation)? These questions must be answered by experimentation
and may be data-set specific.

## Can sourmash run multi-threaded?
bluegenes marked this conversation as resolved.
Show resolved Hide resolved

sourmash is currently single-threaded, but the [branchwater plugin for sourmash](https://github.com/sourmash-bio/sourmash_plugin_branchwater) provides faster and lower-memory multithreaded implementations of several important sourmash features - sketching, searching, and gather (metagenome decomposition). It does so by implementing higher-level functions in Rust on top of the core Rust library of sourmash. As a result it provides some of the same functionality as sourmash, but 10-100x faster and in 10x lower memory. Note that this code is functional and tested, but does not have all of the features of sourmash. Code and features will be integrated back into sourmash as they mature.
8 changes: 7 additions & 1 deletion doc/index.md
Expand Up @@ -58,6 +58,8 @@ sourmash is inspired by [mash](https://mash.readthedocs.io), and
supports most mash analyses. sourmash also implements an expanded set
of functionality for metagenome and taxonomic analysis.

While sourmash is currently single-threaded, the [branchwater plugin for sourmash](https://github.com/sourmash-bio/sourmash_plugin_branchwater) provides faster and lower-memory multithreaded implementations of several important sourmash features - sketching, searching, and gather (metagenome decomposition). It does so by implementing higher-level functions in Rust on top of the core Rust library of sourmash. As a result it provides some of the same functionality as sourmash, but 10-100x faster and in 10x lower memory. Note that this code is functional and tested, but does not have all of the features of sourmash. Code and features will be integrated back into sourmash as they mature.

sourmash development was initiated with a grant from the Moore
Foundation under the Data Driven Discovery program, and has been
supported by further funding from the NIH and NSF. Please see
Expand Down Expand Up @@ -94,6 +96,10 @@ X and Linux. They require about 5 GB of disk space and 5 GB of RAM.

* [A short guide to using sourmash output with R](other-languages.md).

## Frequently Asked Questions

* [Frequently asked questions](faq.md)

### How sourmash works under the hood

* [An introduction to k-mers for genome comparison and analysis](kmers-and-minhash.ipynb)
Expand Down Expand Up @@ -128,6 +134,6 @@ hidden: true

sidebar
command-line
api-example
databases
api-example
```
5 changes: 4 additions & 1 deletion doc/sidebar.md
Expand Up @@ -25,6 +25,10 @@ X and Linux. They require about 5 GB of disk space and 5 GB of RAM.

* [A short guide to using sourmash output with R](other-languages.md).

## Frequently Asked Questions

* [Frequently asked questions](faq.md)

## How sourmash works under the hood

* [An introduction to k-mers for genome comparison and analysis](kmers-and-minhash.ipynb)
Expand All @@ -38,7 +42,6 @@ X and Linux. They require about 5 GB of disk space and 5 GB of RAM.
* [Publications about sourmash](publications.md)
* [A guide to the internal design and structure of sourmash](sourmash-internals.md)
* [Funding acknowledgements](funding.md)
* [Frequently asked questions](faq.md)

## Developing and extending sourmash

Expand Down