datavalidation package

Subpackages

• core package
  • Submodules
  • core.bikegeometry module
    • BikeGeometry
  • core.config module
    • config
  • core.constants module
    • constants
  • core.geometryparameter module
    • GeometryParameter
• normalisation package
  • Submodules
  • normalisation.measure module
    • measure
  • normalisation.normalise module
    • normalise
  • normalisation.number module
    • number
• validation package
  • Submodules
  • validation.constraints module
    • constraints
  • validation.equations module
    • equations
  • validation.formulae module
    • equations
  • validation.validate module
    • validate

datavalidation module

datavalidation

Main module of the datavalidation package. It contains functions to validate bike geometries.

Author: Javier Chiyah and Mario Vasilev, Heriot-Watt University, 2019

datavalidation.datavalidation.request_validate_bike_geometry(request_content: dict) → dict

Request to validate a bike geometry.

Example request:

{
        "geometries": [
                {
                        "geometry_threshold": 0.7,
                        "parameter_threshold": 0.7,
                        "parameter_list": [
                                {
                                        "p": "reach",
                                        "v": "371",
                                        "id": "**any-value**"
                                },
                                {
                                        "p": "stack",
                                        "v": "533",
                                        "id": "**any-value**"
                                }
                        ]
                }
        ]
        # more parameters of the request ...
}

Check the usage document for more information.

Parameters:request_content – content of the request as a dict Returns:request response as a dict

datavalidation.datavalidation.validate_bike_geometry(bike_geometry_dict: dict) → dict

Validates a bike geometry given a dictionary representing one.

Example bike geometry dict:

{
        "parameter_list": [
                {
                        "p": "reach",
                        "v": "371"
                },
                {
                        "p": "stack",
                        "v": "533"
                },
                # more bike geometry parameters ...
        ]
}

Parameters:bike_geometry_dict – bike geometry dict Returns:bike geometry dict

datavalidation.datavalidation.validate_bike_geometry_list(bike_geometry_list: list) → list

Validates a list of bike geometries.

Example list:

[
        # bike geometry
        {
                "parameter_list": [
                        {
                                "p": "reach",
                                "v": "371"
                        },
                        {
                                "p": "stack",
                                "v": "533"
                        }
                ]
        },
        # more geometries ...
]

Parameters:bike_geometry_list – list of bike geometry dicts Returns:list of bike geometry dicts validated