Rigorous-Coupled-Wave-Analysis 项目使用教程

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

Rigorous-Coupled-Wave-Analysis/
├── PWEM_examples/
├── PWEM_functions/
├── RCWA_1D_examples/
├── RCWA_1D_functions/
├── RCWA_2D_examples/
├── RCWA_functions/
├── TMM_examples/
├── TMM_functions/
├── anisotropy_explorations/
├── convolution_matrices/
├── dist/
├── img/
├── notebooks/
├── tests/
├── .DS_Store
├── .gitignore
├── LICENSE
├── MANIFEST
├── README.md
├── settings.py
└── setup.py

目录结构介绍

• PWEM_examples/ 和 PWEM_functions/：包含平面波展开方法（Plane Wave Expansion Method）的示例和功能模块。
• RCWA_1D_examples/ 和 RCWA_1D_functions/：包含一维严格耦合波分析（RCWA）的示例和功能模块。
• RCWA_2D_examples/ 和 RCWA_functions/：包含二维严格耦合波分析（RCWA）的示例和功能模块。
• TMM_examples/ 和 TMM_functions/：包含传输矩阵方法（Transfer Matrix Method）的示例和功能模块。
• anisotropy_explorations/ 和 convolution_matrices/：包含各向异性探索和卷积矩阵的相关代码。
• dist/ 和 img/：包含项目构建和图像资源。
• notebooks/ 和 tests/：包含Jupyter笔记本和测试代码。
• .DS_Store 和 .gitignore：系统文件和Git忽略文件。
• LICENSE 和 MANIFEST：项目许可证和清单文件。
• README.md：项目介绍和使用说明。
• settings.py：项目配置文件。
• setup.py：项目安装文件。

2. 项目的启动文件介绍

项目的启动文件是 setup.py。该文件用于安装项目的依赖项并设置项目的运行环境。

setup.py 文件内容概述

from setuptools import setup, find_packages

setup(
    name='Rigorous-Coupled-Wave-Analysis',
    version='0.1',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'scipy',
        'matplotlib',
    ],
    entry_points={
        'console_scripts': [
            'rcwa_run=rcwa.main:main',
        ],
    },
)

启动步骤

1. 克隆项目到本地：

   git clone https://github.com/zhaonat/Rigorous-Coupled-Wave-Analysis.git
   

2. 进入项目目录：

   cd Rigorous-Coupled-Wave-Analysis
   

3. 安装项目依赖：

   pip install .
   

4. 运行项目：

   rcwa_run
   

3. 项目的配置文件介绍

项目的配置文件是 settings.py。该文件包含了项目的全局配置选项。

settings.py 文件内容概述

# 项目配置文件

# 默认参数设置
DEFAULT_PARAMS = {
    'wavelength': 1.55,  # 波长 (μm)
    'period': 0.5,       # 周期 (μm)
    'num_modes': 10,     # 模式数量
    'polarization': 'TE',  # 偏振模式 (TE 或 TM)
}

# 其他配置选项
DEBUG = True
LOG_LEVEL = 'INFO'

配置文件使用说明

• DEFAULT_PARAMS：包含模拟的默认参数，如波长、周期、模式数量和偏振模式。
• DEBUG：调试模式开关，设置为 True 时启用调试模式。
• LOG_LEVEL：日志级别，设置为 'INFO' 时记录信息日志。

通过修改 settings.py 文件中的配置选项，可以自定义项目的运行参数和行为。