HCIPy 项目启动与配置教程

1. 项目目录结构及介绍

HCIPy 是一个开源的对象化框架，用于执行高对比度成像仪器的端到端模拟。以下是其主要目录结构和文件介绍：

hcipy/
├── .github/                # GitHub 工作流程和 CI 配置文件
├── doc/                    # 项目文档
├── examples/               # 示例代码和脚本
├── hcipy/                  # HCIPy 库的主要代码目录
│   ├── __init__.py
│   ├── core/               # 核心模块，包含基础类和函数
│   ├── propagate/          # 传播模块，包含各种光学传播算法
│   ├── instruments/        # 仪器模块，包含模拟光学元件
│   ├── wavefront/          # 波前模块，包含波前操作相关类
│   ├── coronagraphs/       # 星冕仪模块，包含不同类型的星冕仪
│   ├── sensors/            # 传感器模块，包含波前传感器
│   └── turbulence/         # 湍流模块，包含湍流模拟相关类
├── tests/                  # 测试模块，包含单元测试
├── .coveragerc             # 覆盖率配置文件
├── .flake8                 # Flake8 配置文件，用于代码风格检查
├── .git-blame-ignore-revs  # Git Blame 忽略的修订版本文件
├── .gitignore              # Git 忽略的文件列表
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── pyproject.toml          # 项目构建系统配置文件
└── setup.py                # Python 包配置文件

2. 项目的启动文件介绍

HCIPy 项目的启动主要是通过 Python 包管理器来完成的。以下是一些关键文件：

• setup.py: 这个文件用于定义和打包 HCIPy Python 包。它包含了包的元数据和安装依赖。
• pyproject.toml: 这是一个更新的包配置文件，可以替代 setup.py 使用，它采用 TOML 格式，提供了更清晰和结构化的配置。

要启动项目，通常需要先安装依赖项，然后运行以下命令：

pip install .

这将安装 HCIPy 及其所有依赖项。

3. 项目的配置文件介绍

HCIPy 的配置主要是通过修改项目根目录下的几个配置文件来完成的：

• .flake8: 这个文件用于配置代码风格检查工具 Flake8。可以在此文件中指定要检查的代码风格规则。
• .coveragerc: 这个文件用于配置代码覆盖率工具。它可以设置覆盖率报告的生成方式，以及要包括或排除哪些文件。

此外，HCIPy 的运行可能还需要对一些环境变量进行配置，例如 Python 的环境变量、依赖库的路径等。这些配置通常在操作系统的环境变量设置中进行。

确保正确配置了所有必要的环境和依赖项之后，就可以开始使用 HCIPy 进行高对比度成像模拟了。