1. Introduction to SeqWare
  2. Installation
  3. Getting Started
  4. SeqWare Pipeline
  5. SeqWare MetaDB
  6. SeqWare Portal
  7. SeqWare Web Service
  8. SeqWare Query Engine
  9. Glossary
  10. Frequently Asked Questions
  11. APIs
  12. Source Code
  13. Plugins
  14. Modules
  15. Advanced Topics



This guide will collect the documentation for our various APIs including Javadoc and RESTful web interfaces.

SeqWare Pipeline

The javadoc and test javadoc are intended for use by SeqWare pipeline developers and workflow developers.

SeqWare Web Service

These docs are generated by another nanoc template (just to make it complicated) but will be merged into the main site soon. The API covers the SeqWare Web Service sub-project and is the main RESTful entry point for the project.

SeqWare Query Engine

These docs were generated by Swagger. The API is not currently hooked up to a Hadoop back-end, so queries will not return any valid data. However, this gives an idea as to the general shape of the API.