Usage

You can use Tower through the web interface, the API, the CLI, or Nextflow itself using the -with-tower option.

Tower web interface

1. Create an account and login into Tower, available free of charge, at tower.nf.

2. Create and configure a new compute environment.

3. Start launching pipelines.

Tower API

To learn more about the Tower API, visit the API section in this documentation.

Tower CLI

To learn more about the Tower CLI, visit the CLI section in this documentation.

Nextflow -with-tower

1. Create an account and login into Tower.

2. Create a new token. You can access your tokens from the Settings drop-down menu:

   

3. Name your token.

   

4. Store your token securely.

   

5. Export your token.

6. Once your token has been created, open a terminal and enter the following commands:

   export TOWER_ACCESS_TOKEN=eyxxxxxxxxxxxxxxxQ1ZTE=
   export NXF_VER=20.10.0
   

   Where eyxxxxxxxxxxxxxxxQ1ZTE= is the token you just created.

   Nextflow version

   Bearer token support requires Nextflow version 20.10.0 or later, set with the second command above.

   To submit a pipeline to a Workspace using Nextflow, add the workspace ID to your environment:

   export TOWER_WORKSPACE_ID=000000000000000
   

   The workspace ID can be found on the organisation's Workspaces overview page.

7. Run your Nextflow pipelines as usual with the -with-tower option:

   nextflow run hello.nf -with-tower
   

   You will be able to monitor your workflow runs in Tower!

   To configure and execute Nextflow pipelines in cloud environments, visit the Compute Environments section.

   Tip

   See also the Nextflow documentation for further run configuration via Nextflow configuration files.