跳转到主要内容

用于获取陆地表面模型输入数据的Python包。

项目描述

zampy

下载陆地表面模型(LSM)输入数据的工具。

以“Zam”命名;阿维斯陀语中“大地”的概念

github license badge Documentation Status build workflow scc badge

概述

zampy旨在检索LSM模型输入数据。它可以按照以下步骤帮助您准备数据:

  1. 下载指定位置/地理区域的指定数据。
  2. 摄取数据到统一(zampy)格式。
  3. 加载变量,以标准化的方式进行(标准化的名称和单位)。
  4. 转换数据到标准格式
    • ALMA / PLUMBER2的ALMA格式netCDF。
    • CMOR格式化的netCDF.

(注:目前/低优先级,将不会处理斜体中的条目,但我们希望为未来留出空间。)

入门

安装

workflow pypi badge supported python versions

要安装zampy的最新版本,请执行以下操作:

python3 -m pip install zampy

要从GitHub仓库安装开发版本,请执行以下操作:

python3 -m pip install git+https://github.com/EcoExtreML/zampy.git

配置

Zampy需要使用一个简单的配置文件进行配置。

您需要在您的用户主目录下创建此文件

~/.config/zampy/zampy_config.yml

配置文件应包含working_directory,例如

working_directory: /path_to_a_working_directory/  #for example: /home/bart/Zampy

如果您需要访问CDS或ADS服务器上的数据,您应将您的CDS或ADS凭据添加到zampy_config.yml

cdsapi:
  url:  # for example https://cds.climate.copernicus.eu/api/v2
  key:  # for example 12345:xhashd-232jcsha-dsaj429-cdjajd29319
adsapi:
  url:  # for example https://ads.atmosphere.copernicus.eu/api/v2
  key:  # for example 12345:xhashd-232jcsha-dsaj429-cdjajd29319

有关如何创建CDS或ADS凭据的说明,请参阅下文部分。

如何使用zampy

我们建议用户使用zampy与配方一起使用。

"配方"是一个以.yml扩展名结尾的文件,它定义了

  • 数据下载
    • 时间范围。
    • 空间位置/边界框。
    • 要下载的数据集
      • 数据集中的变量
  • 数据转换
    • 转换为所需的约定
    • 输出频率
    • 输出分辨率

示例配方可以在文档中找到。

当您在磁盘上创建并保存您的配方后,您可以通过在shell中运行以下代码来执行您的配方

zampy /path_to_recipe/sample_recipe.yml

我们还提供Python API供您与zampy交互。您可以在此处找到每个支持的数据集的示例笔记本。

CDS/ADS数据集说明

要下载以下数据集,用户需要通过cdsapi/adsapi访问CDS/ADS

  • CDS
    • ERA5
    • ERA5陆地
    • LAI
    • 陆地覆盖
  • ADS
    • CAMS EGG4(例如co2)

要生成这些API密钥,您需要在CDS通过注册页面注册,或者在ADS通过注册页面注册。

在提交任何请求之前,请将您的cdsapi/adsapi凭据放入zampy_config.yml。以下是如何找到您的CDS/ADS API密钥的简要说明。您可以跳过与.cdsapirc相关的步骤,只需将密钥添加到zampy_config.yml中即可。

同意CDS/ADS的使用条款

当您第一次下载数据集时,必须同意您打算下载的每个数据集的使用条款。这只能通过CDS/ADS网站完成。当您尝试下载这些数据集时,系统将提示您访问使用条款并接受它们。

致谢

此软件包由荷兰eScience中心开发。开发得到了荷兰eScience中心在NLESC.ASDI.2020.026项目号下的支持。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装软件包的更多信息。

源代码分发

zampy-0.2.0.tar.gz (2.8 MB 查看哈希值)

上传时间: 源代码

构建发行版

zampy-0.2.0-py3-none-any.whl (280.7 kB 查看哈希值)

上传时间: Python 3

由以下支持