model_catalogs

通过Intake目录提供对一系列海洋模型的访问，特别是NOAA OFS模型。特别是，这个包非常适合处理未聚合的NOAA OFS模型。

具体功能包括

• 为已知模型设置一个Intake目录，以提供对模型输出的直接访问。
• 以xarray Dataset的形式提供对模型输出的访问。
• 模型通过它们的目录文件而知名；请参阅此处的设置。它们包括
  • NOAA OFS模型
    • CBOFS
    • CIOFS
    • CREOFS
    • DBOFS
    • GOMOFS
    • LEOFS
    • LMHOFS
    • LOOFS
    • NGOFS2
    • NYOFS
    • SFBOFS
    • TBOFS
    • WCOFS
    • 完整的3D字段，或者当可用时为规则网格或2D版本
  • GFS模型
  • 全球GOFS HYCOM
  • RTOFS模型
• 当已知时，提供多个模型输出的时间范围和来源。例如，对于NOAA OFS模型，所有模型都有预报和历史来源，有些还有其他来源。
• model_catalogs知道如何聚合NOAA OFS模型输出，现在预报文件和预报文件之间。
• 已知模型已清理并填充了元数据，因此在xarray和cf-xarray中易于使用。
  • cf-xarray将理解维度和坐标名称，以及映射到变量的标准_names集。
• 模型元数据包含在Intake目录中，例如
  • 数值域的多边形边界
  • 网格参数
  • 使用xarray进行最佳读取的论点
• 可以请求每个模型源的可用性。

安装

PyPI

从PyPI安装

pip install model_catalogs

conda-forge

使用conda-forge通道从conda安装

conda install -c conda-forge model_catalogs

安装可选依赖项

安装完整功能和运行演示笔记本所需的其他依赖项。激活您的Python环境，然后

$ mamba install -c conda-forge --file conda-requirements-opt.txt

如果没有安装mamba，请使用conda代替mamba。

开发软件包

选择环境方法

使用提供的环境

克隆存储库

$ git clone http://github.com/NOAA-ORR-ERD/model_catalogs.git

在model_catalogs目录中，安装conda环境

$ conda env create -f environment.yml

将model_catalogs安装到新环境（仍在model_catalogs目录中）

$ conda activate model_catalogs
$ pip install -e .

使用其他环境

或者，如果您想添加现有环境，克隆存储库

$ git clone http://github.com/NOAA-ORR-ERD/model_catalogs.git
$ cd model_catalogs

确保要使用的环境已激活，然后

$ conda install -c conda-forge --file conda-requirements.txt
$ pip install -r pip-requirements.txt

将model_catalogs安装到该环境（仍在model_catalogs目录中）

$ pip install -e .

安装开发包

要开发代码，根据“使用提供的环境”或“使用其他环境”中的说明进行操作。然后您可以使用以下命令安装开发测试的附加依赖项

$ conda install -c conda-forge --file conda-requirements-dev.txt

运行测试

使用以下命令运行未标记为“慢”的测试

$ pytest

使用以下命令运行所有测试，包括慢测试

$ pytest --runslow

在推送之前在本地检查预提交

然后，在将代码提交并推送到github之前，在本地运行

$ pre-commit run --all-files

这些检查可能会更改您的文件，因此在推送至github之前最好先进行检查。

编译文档

在安装开发包（请参阅“安装开发包”）或使用以下命令创建文档环境之后编译文档

$ conda env create -f docs/environment.yml

并激活该环境。

导航到文档文件夹，并使用以下命令构建html文档

$ make html

最后，您可以通过打开"_build/html/index.html"来确保文档看起来正确。