Quick Start
Install the Latch CLI
-
Install Latch:
Run this in your terminal to install the Latch CLI and all of its dependancies:
FYI: Latch currently supports Python >=3.8, <3.11. Learn More...
FYI: Latch currently supports Python >=3.8, <3.11. Learn More...
We recommend installing Latch SDK in a fresh environment for best behavior.
For Linux/ MacOS
You can use venv to a create an fresh enviroment to install the Latch SDK.
For Windows
The Latch SDK is a Python package, so we recommend installing Latch SDK in a fresh environment for best behavior. To do so, you can use venv.
- First, install the WSL command:
This command will enable the features necessary to run WSL and install the Ubuntu distribution of Linux.
- Activate the Linux shell:
Now, you are in a Linux environment and can create a virtual environment like so:
-
Authenticate with Latch
Run this to authenticate your Latch CLI locally. This will open up a new browser window and authenticate the CLI using your account’s API key.
Create your first workflow
I want to use:
-
Create your workflow from a template
This will download the subprocess workflow template using the Latch SDK framework to a directory called covid-wf.
-
Register your workflow
This will upload your workflow to your account here on Latch where you can then view the parameters and run it.
To launch the workflow, use the Test Data button at the top of the parameters and click Launch.
-
Create your workflow from a template
This will download the subprocess workflow template using the Latch SDK framework to a directory called covid-wf.
-
Register your workflow
This will upload your workflow to your account here on Latch where you can then view the parameters and run it.
To launch the workflow, use the Test Data button at the top of the parameters and click Launch.
-
Create your workflow from a template
This will download the snakemake workflow template to a directory called snakemake-tutorial. Workflows can be written in snakemake and run natively on Latch.
4. Register your workflow
This will upload your workflow to your account here on Latch where you can then view the parameters and run it.
-
Congratulations! You successfully uploaded your first workflow to Latch
Next steps are:
- Understand how to author your own workflow.
- Understand how to test and debug your workflow.
- Read the Concepts page