Skip to content

Commit

Permalink
Update Nextflow instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lbeckman314 committed Jul 31, 2024
1 parent eac39ef commit d7272d4
Showing 1 changed file with 31 additions and 7 deletions.
38 changes: 31 additions & 7 deletions website/content/docs/integrations/nextflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,38 +23,62 @@ To set up Nextflow to use Funnel as the TES executor, run the following steps:

### 1. Install Nextflow

*Adapted from the [Nextflow Documentation](https://nextflow.io/docs/latest/install.html)*

#### a. Install Nextflow:

```sh
curl -s https://get.nextflow.io | bash
```

This will create the nextflow executable in the current directory.

#### b. Make Nextflow executable:

```sh
git clone https://github.com/nextflow-io/nextflow -b tes-update-1.1
chmod +x nextflow
```

cd nextflow
#### c. Move Nextflow into an executable path:

make compile
```sh
sudo mv nextflow /usr/local/bin
```

This will create a new `launch.sh` file that can be used to run the Nextflow workflow below.
#### d. Confirm that Nextflow is installed correctly:

```sh
nextflow info
```

### 2. Update Nextflow Config

Add the following to your `nextflow.config` in order to use the GA4GH TES plugin:

```yaml
cat <<EOF >> nextflow.config
plugins {
id 'nf-ga4gh'
}

process.executor = 'tes'
tes.endpoint = 'http://localhost:8000' # <--- Funnel's default address
EOF
```

### 3. Start Funnel and Run Workflow
### 3. Start the Funnel Server

Finally, start the Funnel server and launch Nextflow:
Start the Funnel server:

```sh
funnel server run
```

### 4. Run Nextflow

alias nextflow=~/nextflow/launch.sh # <--- Change this line to match your local nextflow directory
In another window, run the workflow:

```sh
nextflow run main.nf -c nextflow.config
```

Expand Down

0 comments on commit d7272d4

Please sign in to comment.