PySurfer 项目教程

PySurfer 项目教程

PySurferCortical neuroimaging visualization in Python项目地址:https://gitcode.com/gh_mirrors/py/PySurfer

1. 项目的目录结构及介绍

PySurfer 项目的目录结构如下：

PySurfer/
├── circleci/
│   └── bin/
├── doc/
│   └── ...
├── examples/
│   └── ...
├── make/
│   └── ...
├── surfer/
│   └── ...
├── .coveragerc
├── .gitignore
├── .mailmap
├── .travis.yml
├── CHANGES
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
├── appveyor.yml
├── azure-pipelines.yml
├── codecov.yml
├── setup.cfg
├── setup.py

目录介绍

• circleci/: 包含 CircleCI 配置文件。
• doc/: 包含项目文档的源文件。
• examples/: 包含示例脚本和数据。
• make/: 包含 Makefile 相关文件。
• surfer/: 包含 PySurfer 的核心代码。
• .coveragerc: 代码覆盖率配置文件。
• .gitignore: Git 忽略文件配置。
• .mailmap: 邮件映射文件。
• .travis.yml: Travis CI 配置文件。
• CHANGES: 项目变更记录。
• LICENSE: 项目许可证。
• MANIFEST.in: 清单文件，指定要包含在发布包中的文件。
• Makefile: 构建文件。
• README.md: 项目自述文件。
• appveyor.yml: AppVeyor CI 配置文件。
• azure-pipelines.yml: Azure Pipelines 配置文件。
• codecov.yml: Codecov 配置文件。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。

2. 项目的启动文件介绍

PySurfer 项目的启动文件是 setup.py。这个文件用于安装和管理项目的依赖项，并提供了安装命令。

setup.py 文件介绍

from setuptools import setup, find_packages

setup(
    name='PySurfer',
    version='0.10.0',
    packages=find_packages(),
    install_requires=[
        # 依赖项列表
    ],
    # 其他配置项
)

安装命令

• 全局安装：

  python setup.py install
  

• 本地安装（无 sudo 权限）：

  python setup.py install --home
  

3. 项目的配置文件介绍

PySurfer 项目的配置文件主要包括 setup.cfg 和 .coveragerc。

setup.cfg 文件介绍

setup.cfg 文件包含了安装和构建过程中的配置选项，例如：

[metadata]
name = PySurfer
version = 0.10.0
description = Cortical neuroimaging visualization in Python
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/nipy/PySurfer
author = Michael Waskom, Alexandre Gramfort, Scott Burns, Martin Luessi, Eric Larson
license = BSD-3-Clause

[options]
packages = find:
install_requires =
    # 依赖项列表

[options.package_data]
* = *.txt, *.rst

[tool:pytest]
addopts = --cov=surfer --cov-report=term-missing

.coveragerc 文件介绍

.coveragerc 文件用于配置代码覆盖率测试的选项，例如：

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

[report]
exclude_lines =
    pragma: no cover
    def __repr__
    raise NotImplementedError
    if __name__ == .__main__.:

通过这些配置文件，可以定制项目的安装和测试行为，确保项目在不同环境下的稳定运行。

PySurferCortical neuroimaging visualization in Python项目地址:https://gitcode.com/gh_mirrors/py/PySurfer