管道验证器

安装

您可以使用以下命令安装文件：pip install bbp-atlas-pipeline-validator

示例

您可以使用验证器如下所示

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)

其中

• path_to_file 是配置文件的相对路径
• token 是有效的nexus令牌
• whitelisted_vars 是接受变量的数组

配置格式

JSON配置文件应采用以下格式

{
  "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>"
          }
        ]
    }
  ]
}

验证标准

为了验证配置，需要满足以下标准

• 配置需要遵循上述JSON模式
• 脑区ID必须是有效的（存在于脑区本体中）
• 在每条规则中，每个脑区后面必须跟随与其无关的脑区或它们在本体中的后代
• 对于每个命令，传递的变量必须是白名单变量的一部分

资金与致谢

本软件的开发得到了瑞士联邦理工学院（EPFL）洛桑联邦理工学院（École polytechnique fédérale de Lausanne）的Blue Brain项目的研究中心的支持，该项目由瑞士政府的技术学院委员会资助。

版权所有 © 2023-2024 Blue Brain项目/EPFL