An open API service indexing awesome lists of open source software.

https://github.com/veupathdb/service-multi-blast

Async BLAST+ query service and supporting libraries.
https://github.com/veupathdb/service-multi-blast

blast fasta library ncbi ncbi-blast query service

Last synced: 11 months ago
JSON representation

Async BLAST+ query service and supporting libraries.

Awesome Lists containing this project

README

          

= MultiBlast
:source-highlighter: highlightjs
:icons: font

image:https://img.shields.io/github/license/veupathdb/service-multi-blast[License]

This repository is a "monorepo" containing various projects relating to and
supporting the VEuPathDB MultiBlast service stack.

For development details and information see the
link:docs/development.adoc[Developer Info] doc and/or the
link:docs/design/2.0/design.adoc[Design doc]

An index of available API documentation can be found at
https://veupathdb.github.io/service-multi-blast/

== Projects / Components

=== Services / Images

link:service-query/[BLAST+ Query Service]::
A containerized service whose purpose is the asynchronous execution of BLAST
queries against mounted databases.

link:service-report/[BLAST+ Result Formatting Service]::
A containerized services whose purpose is the asynchronous formatting of ASN.1
BLAST query results into various other formats via the BLAST+ `blast_formatter`
tool.

link:docker-queue-db/[MultiBlast Queue Database]::
Docker image containing setup scripts to provision the database schemata
necessary to support the MultiBlast query and report services.

=== Libraries

link:lib-blast-query-parser/[BLAST+ Query Parsing Tools]::
Multi-sequence BLAST query parsing tool kit.

link:lib-blast-types/[BLAST+ CLI API Wrapper Type Library]::
NCBI BLAST+ tool CLI API wrapper.
+
Allows easy programmatic construction and validation of CLI calls to BLAST+
tools.

link:lib-jvm-mblast-sdk[MultiBlast API SDK]::
JVM SDK for working with the MultiBlast API.

link:lib-mblast-utils/[MultiBlast Common Utilities]::
Various utilities common to the other services and libraries in this repo.

link:lib-temp-cache/[Temp File Management Utilities]::
Expiring temporary file factory.

link:lib-mblast-gradle/[MultiBlast Gradle Plugin]::
A Gradle extension that adds utilities to support the MultiBlast project build
tasks.

=== Deployment

link:stack-mblast[MultiBlast Docker Compose Stack]::
Docker Compose stack configuration for MultiBlast.

link:ddl-oracle/[User Database DDL]::
DDL for the database schema and tables backing MultiBlast in the VEuPathDB user
database.

link:script-mblast2-migration/[v2.0 Migration Script]::
Script to migrate the backing user database from `v0.x` and `v1.x` data to
`v2.x`.

=== Test / Support

link:script-mblast-e2e/[End-to-End Tests]::
Test script that performs end-to-end testing on a running MultiBlast instance.