Validate project
¶
nomenclature validate-project
¶
nomenclature validate-project
Usage:
nomenclature validate-project [OPTIONS] {path}
Validate a nomenclature project directory structure and
content.
Performs comprehensive validation including:
- YAML syntax validation for all files
- Parsing of codelists in the definitions folder
- Validation of model mappings against region codelists
- Consistency checks for required-data and data-validation
criteria
Example:
$ nomenclature validate-project .
-
-definitions
def
-
-mappings
map
╭─
Arguments
──────────────────────────────────────────────────
─╮
│
*
path
<
path
>
Project directory to validate
│
│
[required]
│
╰───────────────────────────────────────────────────────────────╯
╭─
Options
────────────────────────────────────────────────────
─╮
│
-
-definitions
<
str
>
Name of definitions folder
│
│
[default: definitions]
│
│
-
-mappings
<
str
>
Name of mappings folder
│
│
-
-required
-data
<
str
>
Name of required data folder
│
│
-
-validate
-data
<
str
>
Name of data validation folder
│
│
-
-dimension
<
str
>
Dimensions to check (defaults
│
│
to all)
│
│
-
-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:
Validate YAML
Next:
Check region aggregation