The Virtual Brain (TVB) 项目安装与使用教程

The Virtual Brain (TVB) 项目安装与使用教程

tvb-root Main TVB codebase 项目地址: https://gitcode.com/gh_mirrors/tv/tvb-root

1. 项目目录结构及介绍

The Virtual Brain (TVB) 项目的目录结构如下：

tvb-root/
├── dev_resources/
├── tvb_bin/
├── tvb_build/
├── tvb_contrib/
├── tvb_deprecated/
├── tvb_documentation/
├── tvb_framework/
├── tvb_library/
├── tvb_storage/
├── coveragerc
├── gitignore
├── LICENSE
├── README.md
├── codemeta.json
└── sonar-project.properties

目录介绍

• dev_resources: 开发资源目录，包含开发过程中需要的资源文件。
• tvb_bin: 包含 TVB 的可执行文件。
• tvb_build: 构建目录，包含构建 TVB 所需的脚本和配置文件。
• tvb_contrib: 贡献代码目录，包含社区贡献的代码。
• tvb_deprecated: 废弃代码目录，包含不再维护的代码。
• tvb_documentation: 文档目录，包含项目的文档和示例。
• tvb_framework: TVB 框架目录，包含 TVB 的核心框架代码。
• tvb_library: TVB 科学库目录，包含科学计算和模拟的核心库。
• tvb_storage: 存储目录，包含数据存储相关的代码。
• coveragerc: 代码覆盖率配置文件。
• gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。
• codemeta.json: 项目元数据文件。
• sonar-project.properties: SonarQube 配置文件。

2. 项目启动文件介绍

TVB 项目的启动文件主要位于 tvb_framework 目录中。以下是主要的启动文件：

• tvb_framework/interfaces/web/run.py: 这是 TVB Web 界面的启动文件。通过运行此文件，可以启动 TVB 的 Web 图形界面。

启动命令

python -m tvb.interfaces.web.run WEB_PROFILE

此命令将启动一个 CherryPy 服务，默认端口为 8080。启动后，浏览器会自动打开 http://localhost:8080/，用户可以通过此界面与 TVB 进行交互。

3. 项目配置文件介绍

TVB 项目的配置文件主要位于项目的根目录和各个子目录中。以下是主要的配置文件：

• coveragerc: 代码覆盖率配置文件，用于配置代码覆盖率测试的参数。
• sonar-project.properties: SonarQube 配置文件，用于配置 SonarQube 代码质量分析工具的参数。
• setup.py: 安装配置文件，用于配置项目的安装依赖和构建参数。

配置文件示例

coveragerc

[run]
branch = True
omit =
    */tests/*
    */setup.py

sonar-project.properties

sonar.projectKey=tvb-root
sonar.sources=tvb_framework, tvb_library
sonar.python.coverage.reportPaths=coverage.xml

setup.py

from setuptools import setup, find_packages

setup(
    name='tvb-framework',
    version='2.9.1',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'scipy',
        'cherrypy',
        # 其他依赖项
    ],
    extras_require={
        'test': [
            'pytest',
            'pytest-benchmark',
            'pytest-mock',
            'BeautifulSoup4',
            # 其他测试依赖项
        ],
    },
)

通过这些配置文件，用户可以自定义 TVB 项目的构建、测试和代码质量分析过程。

tvb-root Main TVB codebase 项目地址: https://gitcode.com/gh_mirrors/tv/tvb-root