Skip to main content

A pipeline validator for Blue Brain Project

Project description

Pipeline Validator

Install

You can install the file by using pip install bbp-atlas-pipeline-validator

Examples

You can use the validator in the following way:

from pipeline_validator.pipeline_validator import pipeline_validator

path_to_file = "./my_config.json"
token = "THIS_IS_MY_NEXUS_TOKEN"
whitelisted_vars = ["var1", "var2"]

pipeline_validator(path_to_file, token, whitelisted_vars)

where:

  • path_to_file is the relative path to the configuration
  • token is a valid nexus token
  • whitelisted_vars is an array of accepted variables

Configuration Format

The JSON configuration file should be in the following format:

{
  "rules":[
    {
      "rule": "<NAME_OF_RULE_1>",
      "execute":
        [
          {
            "brainRegion": "http://api.brain-map.org/api/v2/data/Structure/<BRAIN_REGION_ID_1>",
            "container": "docker://<PATH_TO_DOCKER_IMAGE>",
            "command": "<THE COMMAND TO BE EXECUTED>"
          },
          {
            "brainRegion": "http://api.brain-map.org/api/v2/data/Structure/<BRAIN_REGION_ID_2>",
            "container": "docker://<PATH_TO_DOCKER_IMAGE>",
            "command": "<THE COMMAND TO BE EXECUTED>"
          }
        ]
    },
    {
      "rule": "<NAME_OF_RULE_2>",
      "execute":
        [
          {
            "brainRegion": "http://api.brain-map.org/api/v2/data/Structure/<BRAIN_REGION_ID_1>",
            "container": "docker://<PATH_TO_DOCKER_IMAGE>",
            "command": "<THE COMMAND TO BE EXECUTED>"
          },
          {
            "brainRegion": "http://api.brain-map.org/api/v2/data/Structure/<BRAIN_REGION_ID_2>",
            "container": "docker://<PATH_TO_DOCKER_IMAGE>",
            "command": "<THE COMMAND TO BE EXECUTED>"
          }
        ]
    }
  ]
}

Validation Criteria

The following criteria need to be met in order for the configuration to be validated:

  • The configuration need to follow the above JSON schema
  • Brain region ID should be valid (exist in brain region ontology)
  • Within each rule, each brain region need to be followed by brain region that are not related or that they are descendants in the ontology
  • For each command, the variables passed need to be part of the whitelisted variables

Funding & Acknowledgment

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

Copyright © 2023-2024 Blue Brain Project/EPFL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bbp_atlas_pipeline_validator-0.4.0.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file bbp_atlas_pipeline_validator-0.4.0.tar.gz.

File metadata

File hashes

Hashes for bbp_atlas_pipeline_validator-0.4.0.tar.gz
Algorithm Hash digest
SHA256 6722dbe1d10f5b1cdd4b16e2901f439ef647fb89711315a17e9337903a721019
MD5 42d998896b7c38c3e2a1d5be29df01d3
BLAKE2b-256 dac2542dcee3428fc4dc91d2868b5cfcbe0180c31f1d117684bdea1653d4a50e

See more details on using hashes here.

File details

Details for the file bbp_atlas_pipeline_validator-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for bbp_atlas_pipeline_validator-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b536004a199c3d6752681d0b2eba01e37d4e80cf4b5fc3acb1081af57e29bd3c
MD5 a47a2449e1fe8bee45249b443beeb0cb
BLAKE2b-256 9a6777aed96ffb73071cb91d461ed78c40e5cecc29a71a6b22a776da1b6beec0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page