Run workflow
¶
nomenclature run-workflow
¶
nomenclature run-workflow
Usage:
nomenclature run-workflow [OPTIONS] {input_file}
Execute a custom Python workflow on IAMC data.
Loads a function from a Python file and applies it to process
scenario data.
The workflow function should accept an IamDataFrame and return
an IamDataFrame.
Useful for project-specific data transformations and
validation.
Example:
$ nomenclature run-workflow input.xlsx
-
-output
-file
output.xlsx
╭─
Arguments
──────────────────────────────────────────────────
─╮
│
*
input_file
<
path
>
Input IAMC data file
[required]
│
╰───────────────────────────────────────────────────────────────╯
╭─
Options
────────────────────────────────────────────────────
─╮
│
-
-workflow
-file
<
path
>
Python workflow file
│
│
[default:
│
│
/home/docs/checkouts/read…
│
│
-
-workflow
-function
<
str
>
Function name in workflow
│
│
file
│
│
[default: main]
│
│
-
-output
-file
<
path
>
Output file for processed
│
│
data
│
│
-
-help
Show this message and
│
│
exit.
│
╰───────────────────────────────────────────────────────────────╯
nomenclature
A Python package for working with IAMC-style scenario data
Navigation
Installation
User Guide
API documentation
Command line interface
Validate YAML
Validate project
Check region aggregation
Export definitions
List missing variables
Run workflow
Validate scenarios
Convert Excel codelist to YAML
Parse model registration
Related Topics
Documentation overview
Command line interface
Previous:
List missing variables
Next:
Validate scenarios