Skip to content

Latest commit

 

History

History
136 lines (88 loc) · 5.79 KB

README.md

File metadata and controls

136 lines (88 loc) · 5.79 KB
Raw

tw-pywrap

tw-pywrap is a Python wrapper for the Nextflow Tower CLI. It can be leveraged to automate the creation of all of the entities in Nextflow Tower via a simple configuration file in YAML format.

The key features are:

  • Simple configuration: All of the command-line options available when using the Nextflow Tower CLI can be defined in simple YAML format.
  • Infrastructure as Code: Enable users to manage and provision their infrastructure specifications.
  • Automation: End-to-end creation of entities within Nextflow Tower, all the way from adding an Organization to launching pipeline(s) within that Organization.

Prerequisites

You will need to have an account on Nextflow Tower (see Plans and pricing).

1. Dependencies

tw-pywrap requires the following dependencies:

  1. Nextflow Tower CLI

  2. Python (>=3.8)

  3. PyYAML

Alternatively, you can install the dependencies via Conda by downloading and using the Conda environment file that has been supplied in this repository:

conda env create -f environment.yml
conda activate tw_pywrap

2. Installation

The scripts in this repository will eventually be packaged via pip, but for now you can install the latest development version using the command below:

pip install git+https://github.com/seqeralabs/tw-pywrap.git@main

You can force overwrite the installation to use the latest changes with the command below:

pip install --upgrade --force-reinstall git+https://github.com/seqeralabs/tw-pywrap.git@main

3. Configuration

Create a Tower access token using the Nextflow Tower web interface via the Your Tokens page in your profile.

tw-pywrap reads this token from the environment variable TOWER_ACCESS_TOKEN. Please export it into your terminal as shown below:

export TOWER_ACCESS_TOKEN=<your access token>

Quick start

You must provide a YAML file that defines the options for each of the entities you would like to create in Nextflow Tower.

You will need to have an account on Nextflow Tower (see Plans and pricing).

  • Launching on Tower Cloud

    If you have an account on Tower Cloud you should have access to the community/showcase Workspace. Let's launch a pipeline there!

    1. Create a file called hello_world_config.yml with the contents below:

      launch:
  - name: 'hello-world'                               # Workflow name
    workspace: 'community/showcase'                   # Workspace name
    compute-env: 'AWS_Batch_Ireland_FusionV2_NVMe'    # Compute environment
    revision: 'master'                                # Pipeline revision
    pipeline: 'https://github.com/nextflow-io/hello'  # Pipeline URL

    2. Launch the pipeline with tw-pywrap:

      tw-pywrap hello_world_config.yml

    3. Login to Tower Cloud and check the Runs page in the community/showcase for the pipeline you just launched!

  • Launching on Tower Enterprise

    If you are a customer with Seqera Labs you will need access to a Workspace with Launch permissions, as well as a pre-defined Compute Environment where you can launch a pipeline. Please customise the entries in the config below as required.

    1. Create a file called hello_world_config.yml with the contents below:

      launch:
  - name: 'hello-world'                               # Workflow name
    workspace: '<YOUR_WORKSPACE>'                     # Workspace name
    compute-env: '<YOUR_COMPUTE_ENVIRONMENT>'         # Compute environment
    revision: 'master'                                # Pipeline revision
    pipeline: 'https://github.com/nextflow-io/hello'  # Pipeline URL

    2. Launch the pipeline with tw-pywrap:

      tw-pywrap hello_world_config.yml

    3. Login to your Tower Enterprise instance and check the Runs page in the appropriate Workspace for the pipeline you just launched!

Real world example

We have created an end-to-end example that highlights how you can use tw_pywrap to create everything sequentially in Nextflow Tower all the way from adding a new Organization to launching a pipeline.

Templates

We have provided template YAML files for each of the entities that can be created on Tower. These can be found in the templates/ directory and should form a good starting point for you to add your own customization:

Contributions and Support

If you would like to contribute to tw_pywrap, please see the contributing guidelines.

For further information or help, please don't hesitate to create an issue in this repository.

Credits

tw-pywrap was written by Esha Joshi, Adam Talbot and Harshil Patel from the Scientific Development Team at Seqera Labs.