PyVista 开源项目教程

PyVista 开源项目教程

pyvista3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK)项目地址:https://gitcode.com/gh_mirrors/py/pyvista

项目的目录结构及介绍

PyVista 项目的目录结构如下：

pyvista/
├── Makefile
├── README.rst
├── SECURITY.md
├── codecov.yml
├── environment.yml
├── pyproject.toml
├── requirements.txt
├── requirements_docs.txt
├── requirements_test.txt
├── setup.py
├── pyvista/
│   ├── __init__.py
│   ├── core/
│   ├── examples/
│   ├── filters/
│   ├── plotters/
│   ├── themes/
│   ├── utilities/
│   └── ...
├── docs/
│   ├── Makefile
│   ├── conf.py
│   ├── index.rst
│   └── ...
└── tests/
    ├── __init__.py
    ├── test_core.py
    ├── test_examples.py
    └── ...

主要目录介绍

• pyvista/: 包含 PyVista 库的核心代码。
  • core/: 核心功能模块。
  • examples/: 示例代码。
  • filters/: 过滤器功能模块。
  • plotters/: 绘图功能模块。
  • themes/: 主题设置模块。
  • utilities/: 工具函数模块。
• docs/: 文档目录，包含 Sphinx 文档配置和源文件。
• tests/: 测试代码目录，包含各种单元测试和集成测试。

项目的启动文件介绍

PyVista 项目的启动文件是 setup.py。这个文件用于安装和管理 PyVista 库。通过运行以下命令可以安装 PyVista：

pip install .

setup.py 文件主要负责以下任务：

• 定义项目元数据（如名称、版本、作者等）。
• 指定依赖项。
• 配置构建和安装过程。

项目的配置文件介绍

PyVista 项目的配置文件主要包括以下几个：

• pyproject.toml: 用于配置项目构建工具和依赖项。
• environment.yml: 用于配置 Conda 环境。
• requirements.txt: 列出了项目运行所需的 Python 包。
• requirements_docs.txt: 列出了构建文档所需的 Python 包。
• requirements_test.txt: 列出了运行测试所需的 Python 包。

pyproject.toml 示例

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "pyvista"
version = "0.30.0"
description = "3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK)"
authors = [
    { name="Bane Sullivan", email="bane.sullivan@kitware.com" },
    { name="Alexander Kaszynski", email="akaszynski@kitware.com" }
]
license = { file="LICENSE" }
readme = "README.rst"
requires-python = ">=3.6"
dependencies = [
    "numpy",
    "vtk",
    "matplotlib",
    "imageio"
]

environment.yml 示例

name: pyvista
channels:
  - conda-forge
dependencies:
  - python=3.8
  - numpy
  - vtk
  - matplotlib
  - imageio

通过这些配置文件，用户可以轻松地安装和管理 PyVista 及其依赖项。

pyvista3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK)项目地址:https://gitcode.com/gh_mirrors/py/pyvista