latchbio / latch

a python bioinformatics framework
https://docs.latch.bio
MIT License
162 stars 17 forks source link
![biocompute](static/biocompute.png) # Latch SDK The Latch SDK is a framework to build and deploy bioinformatics workflows, and dynamically generate associated interfaces, with a handful of python functions. It is built directly on [Flyte](https://docs.flyte.org) for all the benefits that the Kubernetes-native workflow orchestration framework provides - task-level type-safety and containerization, independent task scheduling, and heterogeneous & highly scalable computing infrastructure. [Slack Community](https://join.slack.com/t/latchbiosdk/shared_invite/zt-193ibmedi-WB6mBu2GJ2WejUHhxMOuwg) • [Docs](https://docs.latch.bio) • [Installation](#installation) • [Quickstart](#configuration) • [Latch](https://latch.bio) • [Latch Verified](https://github.com/latch-verified) ![side-by-side](static/side-by-side.png)

Workflows developed with the SDK feature:

The Latch SDK is a framework to build workflows. A collection of existing and maintained workflows for common biological assays can be found at Latch Verified.

Quickstart

Getting your hands dirty with SDK is the best way to understand how it works. Run the following three commands in your terminal to register your first workflow to LatchBio.

Prerequisite: ensure that docker is present and running on your machine. (Install docker here if you don't already have it installed.)

First, install latch through pip .

$ python3 -m pip install latch

Then, create some boilerplate code for your new workflow.

$ latch init testworkflow

Finally register the boilerplate code to LatchBio.

$ latch register testworkflow

This might take 3-10 minutes depending on your network connection. (Subsequent registers will complete in seconds by reusing the image layers from this initial register.) The registration process will:

When registration has completed, you should be able to navigate here and see your new workflow in your account.

If you are having issues with registration or have general questions, please file an issue on github.


Installation

The SDK is distributed on pip. Install in a fresh virtual environment for best behavior.

Virtualenvwrapper is recommended.

python3 -m pip install latch

Note that a local installation of docker is required to register workflows.


Examples

Latch Verified features list of well-curated workflows developed by the Latch team.

We'll maintain a growing list of well documented examples developed by our community members here. Please open a pull request to feature your own:

Gene Editing

Phylogenetics

Single-cell Analysis

Protein Engineering