Skip to content

setup.md

Latest commit

 

History

History
71 lines (47 loc) · 1.96 KB

setup.md

File metadata and controls

71 lines (47 loc) · 1.96 KB
title Setup
description How to setup your environment to test the nf-co2footprint plugin locally

Testing and debugging

Option 1: 🛠️ Launch with local Nextflow build

To test with Nextflow for development purpose:

  1. Clone the Nextflow repo into a sibling directory

    cd .. && git clone https://github.com/nextflow-io/nextflow
cd nextflow && ./gradlew exportClasspath

  2. Append the following line to the settings.gradle in this project:

    includeBuild('../nextflow')

  3. Compile the plugin code

    ./gradlew compileGroovy

  4. Run nextflow with this command:

    ./launch.sh run -plugins nf-co2footprint <script/pipeline name> [pipeline params]

Option 2: 🚀 Launch via regularly installed Nextflow

The plugin can be tested without using a local Nextflow build using the following steps:

!!! warning

This will install the compiled plugin code into the `$NXF_PLUGINS_DIR` directory (default: `${HOME}/.nextflow/plugins`). If a plugin with the same version (as specified in `nf-co2footprint/build.gradle`) already exists in this directory, it will be overwritten.

  1. Compile and install the plugin code

    make install

  2. Run nextflow with this command, specifying the plugin version:

    nextflow run <script/pipeline name> [pipeline params] -plugins nf-co2footprint@1.3.0

🧪 Compiling and running tests

To compile and run the tests use the following command:

make test

📄 Change and preview the docs

The docs are generated using Material for MkDocs. To change the docs, edit the files in the docs/ folder and run the following command to generate the docs (after installing mkdocs via pip install mkdocs-material):

mkdocs serve

To preview the docs, open the URL provided by mkdocs in your browser.