Define where the pipeline should find input data and save output data.

Root directory or tarball of all satellite imagery.

required
type: string

Set this to the root directory of all satellite imagery. Directory structure should match format of data downloaded with '$ force-level1-csd
' For concrete directory structure see usage documentation.

Alternatively, a tarball can be supplied. The same directory structure needs to be in place in that tarball.

Digital elevation model.

required
type: string

Path to directory containing a subdirectory with tile-wise digital elevation files (.tif) and a virtual dataset file (.vrt file) comprising all tile-wise files from the subdirectory. See usage documentation for details regarding the required structure.

Alternatively, a tarball can be supplied. The same directory structure needs to be in place in that tarball.

Alternatively, a tarball can be supplied. The same directory structure needs to be in place in that tarball.

Water vapor dataset.

required
type: string

Directory containing a number text files describing global water vapor data at different timestamps, and a coordinate order (.coo-)file containing the reference system of the water vapor data. See usage documentation for details regarding the required structure.

Alternatively, a tarball can be supplied. The same directory structure needs to be in place in that tarball.

Datacube definition.

required
type: string
pattern: ^\S+\.prj$

A single .prj file describing the projection and reference grid of the generated datacube.

Area of interest.

required
type: string
pattern: ^\S+\.(gpkg|shp)$

A single vector file specifying the spatial extend of the targeted area.

Endmember definition.

required
type: string
pattern: ^\S+\.txt$

A single text file specifying where rows correspond to satellite bands and columns correspond to endmembers. Values correspond to reflectance values and are separated by spaces.

The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.

required
type: string

Email address for completion summary.

type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Set this parameter to your e-mail address to get a summary e-mail with details of the run sent to you when the workflow exits. If set in your user config file (~/.nextflow/config) then you don't need to specify this on the command line for every run.

MultiQC report title. Printed as page header, used for filename if not otherwise specified.

type: string

Definition of satellite image parameters.

Satellites for which data should be incorporated into higher level processing.

type: string
default: LND04 LND05 LND07
pattern: ^((LND04|LND05|LND07|LND08|LND09|SEN2A|SEN2B|sen2a|sen2b|S1AIA|S1BIA|S1AID|S1BID|MOD01|MOD02|LNDLG|SEN2L|SEN2H|R-G-B|VVVHP|MODIS)(\s|$))+$

String containing space-separated indicators of satellites in FORCE level 2 format. Common options:
"LND04": 6-band Landsat 4 TM,
"LND05": 6-band Landsat 5 TM,
"LND07": 6-band Landsat 7 ETM+,
"LND08/09": 6-band Landsat 8-9 OLI,
"SEN2A": 10-band Sentinel-2A,
"SEN2B": 10-band Sentinel-2B,
all options here

First day of interest.

type: string
default: 1984-01-01
pattern: ^\d{4}-\d{2}-\d{2}$

String with format: "YYYY-MM-DD".

Last day of interest.

type: string
default: 2006-12-31
pattern: ^\d{4}-\d{2}-\d{2}$

String with format: "YYYY-MM-DD".

Spatial resolution applied in analyses.

type: integer
default: 30

Modify higher level processing behaviour.

Select which bands and indexes should be considered in time series analyses.

type: string
default: NDVI BLUE GREEN RED NIR SWIR1 SWIR2
pattern: ((BLUE|GREEN|RED|NIR|SWIR1|SWIR2|RE1|RE2|RE3|BNIR|NDVI|EVI|NBR|NDTI|ARVI|SAVI|SARVI|TC-BRIGHT|TC-GREEN|TC-WET|TC-DI|NDBI|NDWI|MNDWI|NDMI|NDSI|SMA|kNDVI|NDRE1|NDRE2|CIre|NDVIre1|NDVIre2|NDVIre3|NDVIre1n|NDVIre2n|NDVIre3n|MSRre|MSRren,CCI)(\s|$))+

Space-separated list of indexes and bands that should be considered in time series analyses. They are indicated by using their established abbreviations. The full list of available indexes is available at https://force-eo.readthedocs.io/en/latest/components/higher-level/tsa/param.html under the 'INDEX' parameter. Spectral unmixing is a special index and always activated.

Should the full time series stack be returned.

type: boolean

This parameter enables or disables the output of the time series stack for each tile and band/index. Here, each band shows the values of a single date.

Enable or disable visualizations.

Whether mosaic visualization should be returned.

type: boolean
default: true

Whether pyramid visualization should be returned.

type: boolean
default: true

Parameters that configure workflow behavior not directly related to FORCE,

Whether analysis ready data should be published to the output directory.

type: boolean

By default, the results of preprocessing (aka. analyses ready data or level-2 data) are not published. Setting this parameter to true enforces that these files are published to the output directory.

Whether the results of time series analyses should be published to the output directory.

type: boolean

By default, the results of higher level processing (aka. level-3 data) are not published. Setting this parameter to true enforces that these files are published to the output directory.

Batch size of tiles considered for merging.

type: integer
default: 100

Controls trade-off between parallelism and I/O load.
Higher group_size -> More tiles merged in one process, less I/O load.
Lower group_size -> Less tiles merged in one process, more I/O load.

Publish pipeline outputs.

type: boolean
default: true

Set to false to prevent all modules from publishing their results.

Parameters used to describe centralised config profiles. These should not be edited.

Git commit id for Institutional configs.

hidden
type: string
default: master

Base directory for Institutional configs.

hidden
type: string
default: https://raw.githubusercontent.com/nf-core/configs/master

If you're running offline, Nextflow will not be able to fetch the institutional config files from the internet. If you don't need them, then this is not a problem. If you do need them, you should download the files from the repo and tell Nextflow where to find them with this parameter.

Institutional config name.

hidden
type: string

Institutional config description.

hidden
type: string

Institutional config contact information.

hidden
type: string

Institutional config URL link.

hidden
type: string

Less common options for the pipeline, typically set in a config file.

Display version and exit.

hidden
type: boolean

Method used to save pipeline results to output directory.

hidden
type: string

The Nextflow publishDir option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See Nextflow docs for details.

Email address for completion summary, only when pipeline fails.

hidden
type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.

Send plain-text email instead of HTML.

hidden
type: boolean

File size limit when attaching MultiQC reports to summary emails.

hidden
type: string
default: 25.MB
pattern: ^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$

Do not use coloured log outputs.

hidden
type: boolean

Incoming hook URL for messaging service

hidden
type: string

Incoming hook URL for messaging service. Currently, MS Teams and Slack are supported.

Custom config file to supply to MultiQC.

hidden
type: string

Custom logo file to supply to MultiQC. File name must also be set in the MultiQC config file

hidden
type: string

Custom MultiQC yaml file containing HTML including a methods description.

type: string

Boolean whether to validate parameters against the schema at runtime

hidden
type: boolean
default: true

Base URL or local path to location of pipeline test dataset files

hidden
type: string
default: https://raw.githubusercontent.com/nf-core/test-datasets/