pyfmu.builder.validate¶
Module Contents¶
-
class
pyfmu.builder.validate.ValidationResult¶ Represents the result of validating an FMU with different validation techniques.
-
set_result_for(self, tool: str, valid: bool, message='')¶
-
get_result_for(self, tool: str)¶
-
property
valid(self)¶
-
-
pyfmu.builder.validate.validate(fmu_archive: str, use_fmpy: bool = True, use_fmucheck: bool = False, use_vdmcheck: bool = False)¶
-
pyfmu.builder.validate.validate_project(project) → bool¶ Validate a project to ensure that it is consistent.
- Arguments:
project {PyfmuProject} – The project that is validated
- Returns:
bool – [description]
-
pyfmu.builder.validate.validate_modelDescription(modelDescription: str, use_fmucheck=False, use_vdmcheck=False, vdmcheck_version=FMI_Versions.FMI2) → ValidationResult¶
-
pyfmu.builder.validate._validate_vdmcheck(modelDescription: str, validation_results: ValidationResult, fmi_version=FMI_Versions.FMI2)¶ Validate the model description using the VDMCheck tool.
- Arguments:
modelDescription {str} – textual representation of the model description.
- Keyword Arguments:
fmi_version {FMI_Versions} – [description] (default: {FMI_Versions.FMI2})
- Raises:
ValueError: Raised if an the fmi_version is unknown or if the tool does not support validation thereof.
- Notes:
VDMCheck is implemented in Java, as such it requires java to be available in the path.