@hestia-earth/data-validation 0.37.7 → 0.37.9

package/validation.json

@@ -0,0 +1,639 @@
+{
+  "validations": [
+    {
+      "function": "validate_date_lt_today",
+      "level": "error",
+      "message": "must be before today"
+    },
+    {
+      "function": "validate_list_dates",
+      "level": "error",
+      "message": "must be greater than startDate"
+    },
+    {
+      "function": "validate_list_dates_length",
+      "level": "error",
+      "message": "must contain as many items as values"
+    },
+    {
+      "function": "validate_list_value_between_min_max",
+      "level": "error",
+      "message": "must be between min and max"
+    },
+    {
+      "function": "validate_list_min_below_max",
+      "level": "error",
+      "message": "must be greater than min"
+    },
+    {
+      "function": "validate_list_min_max_lookup",
+      "level": "error",
+      "message": "must be above the minimum"
+    },
+    {
+      "function": "validate_list_min_max_lookup",
+      "level": "error",
+      "message": "must be below the maximum"
+    },
+    {
+      "function": "validate_list_term_percent",
+      "level": "warning",
+      "message": "may be between 0 and 100"
+    },
+    {
+      "function": "validate_list_term_percent",
+      "level": "error",
+      "message": "should be between 0 and 100 (percentage)"
+    },
+    {
+      "function": "validate_list_percent_requires_value",
+      "level": "error",
+      "message": "should have required property 'value'"
+    },
+    {
+      "function": "validate_list_valueType",
+      "level": "error",
+      "message": "the node value type is incorrect"
+    },
+    {
+      "function": "validate_is_region",
+      "level": "error",
+      "message": "must not be a country"
+    },
+    {
+      "function": "validate_region_in_country",
+      "level": "error",
+      "message": "must be within the country"
+    },
+    {
+      "function": "validate_country",
+      "level": "error",
+      "message": "must be a country"
+    },
+    {
+      "function": "validate_coordinates",
+      "level": "error",
+      "message": "does not contain latitude and longitude"
+    },
+    {
+      "function": "validate_area",
+      "level": "warning",
+      "message": "should be equal to boundary"
+    },
+    {
+      "function": "validate_boundary_area",
+      "level": "warning",
+      "message": "should be lower than max size"
+    },
+    {
+      "function": "validate_region_size",
+      "level": "warning",
+      "message": "should be lower than max size"
+    },
+    {
+      "function": "validate_empty_fields",
+      "level": "warning",
+      "message": "may not be empty"
+    },
+    {
+      "function": "validate_linked_source_privacy",
+      "level": "error",
+      "message": "should have the same privacy as the related source"
+    },
+    {
+      "function": "validate_private_has_source",
+      "level": "warning",
+      "message": "should add a source"
+    },
+    {
+      "function": "_validate_list_model",
+      "level": "error",
+      "message": "the value provided is not consistent with the model result"
+    },
+    {
+      "function": "validate_duplicated_term_units",
+      "level": "warning",
+      "message": "should not use identical terms with different units"
+    },
+    {
+      "function": "validate_other_model",
+      "level": "error",
+      "message": "is required when using other model"
+    },
+    {
+      "function": "validate_nested_existing_node",
+      "level": "warning",
+      "message": "should not link to an existing node"
+    },
+    {
+      "function": "validate_nested_existing_node",
+      "level": "warning",
+      "message": "should not link to an existing node"
+    },
+    {
+      "function": "validate_lifespan",
+      "level": "error",
+      "message": "must equal to endDate - startDate in decimal years"
+    },
+    {
+      "function": "validate_method_not_relevant",
+      "level": "warning",
+      "message": "should not use not relevant model"
+    },
+    {
+      "function": "validate_methodTier_not_relevant",
+      "level": "warning",
+      "message": "should not use not relevant methodTier"
+    },
+    {
+      "function": "validate_methodTier_background",
+      "level": "error",
+      "message": "should be equal to one of the allowed values"
+    },
+    {
+      "function": "validate_defaultValue",
+      "level": "warning",
+      "message": "should specify a value when HESTIA has a default one"
+    },
+    {
+      "function": "validate_longFallowDuration",
+      "level": "error",
+      "message": "longFallowDuration must be lower than 5 years"
+    },
+    {
+      "function": "validate_waterRegime_rice_products",
+      "level": "error",
+      "message": "rice products not allowed for this water regime practice"
+    },
+    {
+      "function": "validate_croppingDuration_riceGrainInHuskFlooded",
+      "level": "error",
+      "message": "croppingDuration must be between min and max"
+    },
+    {
+      "function": "validate_excretaManagement",
+      "level": "error",
+      "message": "an excreta input is required when using an excretaManagement practice"
+    },
+    {
+      "function": "validate_no_tillage",
+      "level": "error",
+      "message": "is not allowed in combination with noTillage"
+    },
+    {
+      "function": "validate_tillage_site_type",
+      "level": "warning",
+      "message": "should contain a tillage practice"
+    },
+    {
+      "function": "validate_liveAnimal_system",
+      "level": "warning",
+      "message": "should add an animal production system"
+    },
+    {
+      "function": "validate_pastureGrass_key_termType",
+      "level": "error",
+      "message": "pastureGrass key termType must be landCover"
+    },
+    {
+      "function": "validate_pastureGrass_key_value",
+      "level": "error",
+      "message": "all values must be numbers"
+    },
+    {
+      "function": "validate_pastureGrass_key_value",
+      "level": "error",
+      "message": "the sum of all pastureGrass values must be 100"
+    },
+    {
+      "function": "validate_has_pastureGrass",
+      "level": "warning",
+      "message": "should add the term pastureGrass"
+    },
+    {
+      "function": "validate_permanent_crop_productive_phase",
+      "level": "error",
+      "message": "must add the term productivePhasePermanentCrops"
+    },
+    {
+      "function": "validate_primaryPercent",
+      "level": "error",
+      "message": "primaryPercent not allowed on this siteType"
+    },
+    {
+      "function": "validate_processing_operation",
+      "level": "error",
+      "message": "must have a primary processing operation"
+    },
+    {
+      "function": "validate_landCover_match_products",
+      "level": "error",
+      "message": "at least one landCover practice must match an equivalent product"
+    },
+    {
+      "function": "validate_practices_management",
+      "level": "error",
+      "message": "should match the site management node value"
+    },
+    {
+      "function": "validate_irrigated_complete_has_inputs",
+      "level": "error",
+      "message": "must contain water inputs"
+    },
+    {
+      "function": "validate_soilTexture",
+      "level": "error",
+      "message": "is outside the allowed range"
+    },
+    {
+      "function": "validate_depths",
+      "level": "error",
+      "message": "must be greater than or equal to depthUpper"
+    },
+    {
+      "function": "validate_required_depths",
+      "level": "error",
+      "message": "must set both depthUpper and depthLower"
+    },
+    {
+      "function": "validate_required_depths",
+      "level": "warning",
+      "message": "should set both depthUpper and depthLower"
+    },
+    {
+      "function": "validate_term_unique",
+      "level": "error",
+      "message": "must be unique"
+    },
+    {
+      "function": "validate_with_models",
+      "level": "warning",
+      "message": "the measurement provided might be in error"
+    },
+    {
+      "function": "validate_value_length",
+      "level": "error",
+      "message": "must not contain more than 1 value"
+    },
+    {
+      "function": "validate_water_measurements",
+      "level": "error",
+      "message": "must specify water type for ponds"
+    },
+    {
+      "function": "validate_water_salinity",
+      "level": "error",
+      "message": "invalid water salinity"
+    },
+    {
+      "function": "validate_characterisedIndicator_model",
+      "level": "error",
+      "message": "is not allowed for this characterisedIndicator"
+    },
+    {
+      "function": "_below_occupation",
+      "level": "error",
+      "message": "must be less than or equal to land occupation"
+    },
+    {
+      "function": "validate_inonising_compounds_waste",
+      "level": "error",
+      "message": "should be equal to one of the allowed values"
+    },
+    {
+      "function": "validate_empty",
+      "level": "error",
+      "message": "should not be empty"
+    },
+    {
+      "function": "validate_linked_cycle_product",
+      "level": "error",
+      "message": "should be included in the cycle products"
+    },
+    {
+      "function": "validate_linked_cycle_endDate",
+      "level": "error",
+      "message": "must be equal to the Cycle endDate"
+    },
+    {
+      "function": "validate_functionalUnit_not_1_ha",
+      "level": "error",
+      "message": "must not be equal to 1 ha"
+    },
+    {
+      "function": "validate_cycle_dates",
+      "level": "error",
+      "message": "must be greater than startDate"
+    },
+    {
+      "function": "validate_cycle_dates",
+      "level": "error",
+      "message": "must be in the same format as endDate"
+    },
+    {
+      "function": "validate_sum_aboveGroundCropResidue",
+      "level": "error",
+      "message": "must be more than or equal to other crop residues"
+    },
+    {
+      "function": "validate_crop_residue_complete",
+      "level": "error",
+      "message": "must specify the fate of cropResidue"
+    },
+    {
+      "function": "validate_crop_residue_incomplete",
+      "level": "warning",
+      "message": "should specify the fate of cropResidue"
+    },
+    {
+      "function": "validate_cycleDuration",
+      "level": "error",
+      "message": "must equal to endDate - startDate in days"
+    },
+    {
+      "function": "validate_maximum_cycleDuration",
+      "level": "error",
+      "message": "must be below maximum cycleDuration"
+    },
+    {
+      "function": "validate_riceGrainInHuskFlooded_minimum_cycleDuration",
+      "level": "warning",
+      "message": "should be more than the cropping duration"
+    },
+    {
+      "function": "validate_crop_siteDuration",
+      "level": "error",
+      "message": "should not be equal to cycleDuration for crop"
+    },
+    {
+      "function": "validate_siteDuration",
+      "level": "error",
+      "message": "must be less than or equal to cycleDuration"
+    },
+    {
+      "function": "validate_durations",
+      "level": "warning",
+      "message": "should add the fields for a relative cycle"
+    },
+    {
+      "function": "validate_possibleCoverCrop",
+      "level": "error",
+      "message": "cover crop cycle contains non cover crop product"
+    },
+    {
+      "function": "validate_set_treatment",
+      "level": "warning",
+      "message": "should specify a treatment when experimentDesign is specified"
+    },
+    {
+      "function": "validate_products_animals",
+      "level": "warning",
+      "message": "should not specify both liveAnimal and animalProduct"
+    },
+    {
+      "function": "validate_stocking_density",
+      "level": "warning",
+      "message": "should add the term stockingDensityPermanentPastureAverage"
+    },
+    {
+      "function": "validate_linked_impact_assessment",
+      "level": "error",
+      "message": "multiple ImpactAssessment are associated with this Product"
+    },
+    {
+      "function": "validate_linked_impact_assessment",
+      "level": "error",
+      "message": "no ImpactAssessment are associated with this Product"
+    },
+    {
+      "function": "validate_animal_product_mapping",
+      "level": "error",
+      "message": "is not an allowed animalProduct"
+    },
+    {
+      "function": "validate_requires_substrate",
+      "level": "error",
+      "message": "must add substrate inputs"
+    },
+    {
+      "function": "validate_property_valueType",
+      "level": "error",
+      "message": "the property value type is incorrect"
+    },
+    {
+      "function": "validate_term_type",
+      "level": "error",
+      "message": "can not be used on this termType"
+    },
+    {
+      "function": "validate_default_value",
+      "level": "warning",
+      "message": "should be within percentage of default value"
+    },
+    {
+      "function": "validate_economicValueShare",
+      "level": "error",
+      "message": "economicValueShare should sum to 100 or less across all products"
+    },
+    {
+      "function": "validate_value_empty",
+      "level": "warning",
+      "message": "may not be 0"
+    },
+    {
+      "function": "validate_value_0",
+      "level": "error",
+      "message": "economicValueShare must be 0 for product value 0"
+    },
+    {
+      "function": "validate_value_0",
+      "level": "error",
+      "message": "revenue must be 0 for product value 0"
+    },
+    {
+      "function": "validate_primary",
+      "level": "error",
+      "message": "only 1 primary product allowed"
+    },
+    {
+      "function": "validate_product_ha_functional_unit_ha",
+      "level": "error",
+      "message": "must be below or equal to 1 for unit in ha"
+    },
+    {
+      "function": "_validate_product_yield",
+      "level": "warning",
+      "message": "is outside confidence interval"
+    },
+    {
+      "function": "validate_excreta_product",
+      "level": "warning",
+      "message": "should add an excreta product"
+    },
+    {
+      "function": "validate_excreta_product",
+      "level": "error",
+      "message": "is not an allowed excreta product"
+    },
+    {
+      "function": "validate_organisation_dates",
+      "level": "error",
+      "message": "must be greater than startDate"
+    },
+    {
+      "function": "validate_has_animals",
+      "level": "warning",
+      "message": "should specify the herd composition"
+    },
+    {
+      "function": "validate_duplicated_feed_inputs",
+      "level": "error",
+      "message": "must not add the feed input to the Cycle as well"
+    },
+    {
+      "function": "validate_has_pregnancyRateTotal",
+      "level": "warning",
+      "message": "should specify the pregnancy rate"
+    },
+    {
+      "function": "validate_must_include_id",
+      "level": "warning",
+      "message": "should add missing inputs"
+    },
+    {
+      "function": "validate_related_impacts",
+      "level": "error",
+      "message": "can not be linked to the same type"
+    },
+    {
+      "function": "_validate_input_value",
+      "level": "warning",
+      "message": "is outside confidence interval"
+    },
+    {
+      "function": "validate_animalFeed_requires_isAnimalFeed",
+      "level": "error",
+      "message": "must specify is it an animal feed"
+    },
+    {
+      "function": "validate_saplings",
+      "level": "error",
+      "message": "saplings cannot be used as an input here"
+    },
+    {
+      "function": "validate_input_is_product",
+      "level": "error",
+      "message": "must be a product"
+    },
+    {
+      "function": "_validate_all_values",
+      "level": "warning",
+      "message": "may not all be set to false"
+    },
+    {
+      "function": "_validate_material",
+      "level": "error",
+      "message": "must be set to false when specifying fuel use"
+    },
+    {
+      "function": "_validate_freshForage",
+      "level": "error",
+      "message": "must have inputs representing the forage when set to true"
+    },
+    {
+      "function": "_validate_ingredient",
+      "level": "error",
+      "message": "must have inputs to represent ingredients"
+    },
+    {
+      "function": "_validate_ingredient",
+      "level": "error",
+      "message": "ingredients should be complete"
+    },
+    {
+      "function": "_validate_animalPopulation",
+      "level": "error",
+      "message": "animal population must not be complete"
+    },
+    {
+      "function": "_validate_completeness_blank_nodes_key",
+      "level": "error",
+      "message": "must not be blank if complete"
+    },
+    {
+      "function": "validate_has_termType",
+      "level": "warning",
+      "message": "should contain at least one management node"
+    },
+    {
+      "function": "validate_exists",
+      "level": "warning",
+      "message": "should contain at least one management node"
+    },
+    {
+      "function": "validate_fallow_dates",
+      "level": "error",
+      "message": "duration must be in specified interval"
+    },
+    {
+      "function": "validate_cycles_overlap",
+      "level": "error",
+      "message": "management date must be before cycle start date"
+    },
+    {
+      "function": "validate_site_dates",
+      "level": "error",
+      "message": "must be greater than startDate"
+    },
+    {
+      "function": "validate_cycle_dates",
+      "level": "error",
+      "message": "multiple cycles on the same site cannot overlap"
+    },
+    {
+      "function": "validate_cycles_linked_ia",
+      "level": "error",
+      "message": "cycles linked together cannot be added to the same site"
+    },
+    {
+      "function": "validate_linked_impactAssessment",
+      "level": "error",
+      "message": "must be linked to a verified country-level Impact Assessment"
+    },
+    {
+      "function": "validate_id",
+      "level": "error",
+      "message": "aggregation id must contain a product, region, start, and end year"
+    },
+    {
+      "function": "_validate_previous_term",
+      "level": "error",
+      "message": "must point to a previous transformation in the list"
+    },
+    {
+      "function": "_validate_previous_input",
+      "level": "error",
+      "message": "at least one Input must be a Product of the Cycle"
+    },
+    {
+      "function": "_validate_previous_input",
+      "level": "error",
+      "message": "at least one Input must be a Product of the previous Transformation"
+    },
+    {
+      "function": "_validate_previous_product_value",
+      "level": "error",
+      "message": "must be equal to previous product multiplied by the share"
+    },
+    {
+      "function": "validate_linked_emission",
+      "level": "warning",
+      "message": "should be linked to an emission in the Cycle"
+    },
+    {
+      "function": "validate_excreta_inputs_products",
+      "level": "error",
+      "message": "must be included as an Input"
+    }
+  ]
+}

package/.coveragerc

@@ -1,14 +0,0 @@
-[run]
-omit =
-    setup.py
-    build_mocking.py
-    validateData.py
-    run.py
-    **/version.py
-    tests/*
-    hestia_earth/validation/log.py
-    hestia_earth/validation/gee.py
-    hestia_earth/validation/mocking/*
-
-[html]
-directory=coverage

package/.dockerignore

@@ -1,19 +0,0 @@
-bin/
-coverage/
-dist/
-docs/
-node_modules/
-samples/
-scripts/
-tmp/
-envs/
-.coveragerc
-.flake8
-*.json
-*.md
-*.sh
-*.yml
-.git
-.gitlab
-layer/python/
-*.zip

package/.eslintignore

@@ -1,17 +0,0 @@
-.eslintrc.js
-coverage
-build
-build-lambdas
-commitlint.config.js
-.mocharc.js
-alembic/
-app/
-data/
-dist/
-doc/
-layer/
-load_testing/
-rabbit/
-samples/
-scripts/
-jest.config.js

package/.eslintrc.js

@@ -1,11 +0,0 @@
-module.exports = {
-  env: {
-    node: true
-  },
-  extends: ['@hestia-earth/eslint-config'],
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    project: 'tsconfig.json',
-    sourceType: 'module'
-  }
-};