ITU-Rpy 项目使用教程

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

ITU-Rpy 是一个 Python 实现的 ITU-R P. 推荐的大气衰减模型。以下是其目录结构及其简要介绍：

ITU-Rpy/
├── .github/              # GitHub 相关的配置文件
├── docs/                 # 项目文档
├── examples/             # 使用示例
├── itur/                 # 核心代码模块
├── test/                 # 测试代码
├── .gitattributes/       # Git 属性配置
├── .gitignore/           # Git 忽略文件配置
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE.txt           # 项目许可证
├── MANIFEST.in           # 打包配置
├── README.md             # 项目介绍
├── README.rst            # 项目介绍（reStructuredText 格式）
├── codevoc.yml           # 代码词汇表
├── requirements.txt      # 项目依赖
├── setup.cfg             # 设置配置
├── setup.py              # 设置脚本

• .github/: 包含 GitHub 工作流程和模板等。
• docs/: 包含项目的文档资料。
• examples/: 提供了一些使用ITU-Rpy的示例代码。
• itur/: 包含了 ITU-Rpy 的主要功能和模型实现。
• test/: 包含了用于验证 ITU-Rpy 功能的测试代码。
• .gitattributes/: 配置 Git 处理文件的各种属性。
• .gitignore/: 指定 Git 忽略跟踪的文件。
• CONTRIBUTING.md: 为贡献者提供指南。
• LICENSE.txt: 项目使用的 MIT 许可证文本。
• MANIFEST.in: 指定打包时包含的文件。
• README.md: 项目的主介绍文件。
• README.rst: 项目介绍文件的 reStructuredText 格式版本。
• codevoc.yml: 用于代码词汇的描述。
• requirements.txt: 列出了项目运行所依赖的 Python 包。
• setup.cfg: 包含了项目的打包和分发配置。
• setup.py: 用于构建和打包项目的 Python 脚本。

2. 项目的启动文件介绍

ITU-Rpy 项目的启动主要是通过其 Python 包中的函数和类来进行的。没有特定的启动文件，但是以下是一个基本的示例，展示了如何导入 ITU-Rpy 的模块并使用其中的功能：

import itur

# 定义频率、天线尺寸、仰角等参数
frequency = 22.5 * itur.u.GHz  # 链接频率
dish_diameter = 1 * itur.u.m   # 接收天线尺寸
elevation_angle = 60           # 仰角
time_percent = 3               # 衰减值被超过的百分比时间

# 生成规则的纬度和经度网格点
latitude, longitude = itur.utils.regular_lat_lon_grid()

# 计算大气衰减
atmospheric_attenuation = itur.atmospheric_attenuation_slant_path(
    latitude, longitude, frequency, elevation_angle, time_percent, dish_diameter)

# 可视化衰减结果
itur.plotting.plot_in_map(atmospheric_attenuation.value, latitude, longitude, cbar_text='大气衰减 [dB]')

这个代码片段展示了如何使用 ITU-Rpy 来计算和可视化特定参数下的大气衰减。

3. 项目的配置文件介绍

ITU-Rpy 的配置主要是通过 Python 包的 setup.py 文件来进行的，以下是该文件的主要内容：

from setuptools import setup, find_packages

setup(
    name='ITU-Rpy',
    version='0.4.0',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'scipy',
        'pyproj',
        'astropy',
        # 推荐安装的包
        'cartopy',
        'matplotlib',
    ],
    # 其他元数据
    author='Inigo del Portillo',
    author_email='[e-mail]',
    description='A python implementation of the ITU-R P. Recommendations to compute atmospheric attenuation in slant and horizontal paths.',
    license='MIT',
    keywords='satellite atmospheric-modelling',
    url='https://github.com/inigodelportillo/ITU-Rpy',
    # 其他选项...
)

这个文件定义了 ITU-Rpy 包的名称、版本、包含的包、依赖项和其他元数据。用户可以通过修改 install_requires 列表来添加或删除项目依赖。此外，ITU-Rpy 还推荐安装 cartopy 和 matplotlib 以便在地图上显示结果。