-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dev' into extend_summary
- Loading branch information
Showing
1 changed file
with
13 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,31 +5,6 @@ description: How to contribute to nf-co2footprint | |
|
||
# Getting started with plugin development | ||
|
||
## Compiling | ||
|
||
To compile and run the tests use the following command: | ||
|
||
```bash | ||
./gradlew check | ||
``` | ||
|
||
## Launch without a local Nextflow build | ||
|
||
The plugin can be tested prior release without using a local Nextflow build using the following steps: | ||
|
||
1. Build the plugin: | ||
|
||
```bash | ||
make buildPlugins | ||
``` | ||
|
||
2. Copy `build/plugins/nf-co2footprint-<version>` to `$HOME/.nextflow/plugins` | ||
4. Run nextflow with this command: | ||
|
||
```bash | ||
nextflow run -plugins [email protected] <script/pipeline name> [pipeline params] | ||
``` | ||
|
||
## Launch it with Nextflow | ||
|
||
To test with Nextflow for development purpose: | ||
|
@@ -59,7 +34,9 @@ To test with Nextflow for development purpose: | |
./launch.sh run -plugins nf-co2footprint <script/pipeline name> [pipeline params] | ||
``` | ||
|
||
## Alternative: Compile and install to Nextflow plugins directory | ||
## Alternative: Launch without a local Nextflow build | ||
|
||
The plugin can be tested without using a local Nextflow build using the following steps: | ||
|
||
!!! warning | ||
|
||
|
@@ -76,10 +53,19 @@ To test with Nextflow for development purpose: | |
2. Run nextflow with this command, specifying the plugin version: | ||
|
||
```bash | ||
nextflow run -plugins nf-co2footprint@0.4.0 <script/pipeline name> [pipeline params] | ||
nextflow run -plugins nf-co2footprint@0.1.0 <script/pipeline name> [pipeline params] | ||
``` | ||
|
||
|
||
## Compiling and running tests | ||
|
||
To compile and run the tests use the following command: | ||
|
||
```bash | ||
./gradlew check | ||
``` | ||
|
||
|
||
## Change and preview the docs | ||
|
||
The docs are generated using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). To change the docs, edit the files in the [docs/](docs/) folder and run the following command to generate the docs (after installing mkdocs via `pip install mkdocs-material`): | ||
|