threedi-scenario-downloader

用于下载3Di场景结果的工具

项目描述

threedi-scenario-downloader软件包包含用于自动化3Di结果中最常用的下载操作的函数。

示例方法包括

下载原始结果。
下载日志。
下载最大水深（非时间序列栅格）。
下载水深（时间序列栅格，提供快照的时间戳）。
根据模型slug或场景名称查找所有场景。

示例

开始导入包

>>> from threedi_scenario_downloader import downloader as dl

设置用于Lizard API认证的API密钥（您可以从这里获取API密钥：<your portal>.lizard.net/management/#/personal_api_keys）

>>> dl.set_api_key("INSERT YOUR API KEY HERE")

根据模型slug（唯一的模型标识符）或场景名称查找场景。除非另有说明，否则返回最后10个匹配结果

>>> scenarios = dl.find_scenarios_by_model_slug("enter your model_uuid", limit=10)

或者

>>> scenarios = dl.find_scenarios_by_name("my_first_scenario", limit=100)

如果存在太多类似命名的场景，则进行区分大小写的精确搜索

>>> scenarios = dl.find_scenarios_by_exact_name("my_first_scenario", limit=100)

您想下载特定场景的原始3Di结果（.nc和.h5文件）吗？请使用以下方法

>>> dl.download_raw_results("scenario_uuid")
>>> dl.download_grid_administration("scenario_uuid")

或者

>>> dl.download_raw_results("scenario_uuid",pathname="save_under_different_name.nc")
>>> dl.download_grid_administration("scenario_uuid",pathname="save_under_different_name.h5")

可以使用以下方法下载特定场景的（时间序列）栅格

>>> dl.download_maximum_waterdepth_raster("scenario_uuid",projection="EPSG:28992",resolution=10)
#download the full extent of the maximum waterdepth of the given scenario_uuid with a 10 meter resolution in the RD New/Amersfoort projection (EPSG:28992)

>>> dl.download_waterdepth_raster("scenario_uuid",projection="EPSG:28992",resolution=10,time="2019-01-01T02:00")
#download the full extend of the waterdepth at the supplied timestamp given scenario_uuid, on 10 meter resolution in the RD New/Amersfoort projection (EPSG:28992)

栅格下载方法为API创建一个任务。根据大小和分辨率，栅格的准备工作需要一些时间。这些方法会持续检查栅格是否准备好下载。当栅格准备好下载时，Lizard门户中也会创建一条消息。如果您想删除这些消息（例如，由于批量下载），请使用以下方法

>>> dl.clear_inbox()

安装

我们可以使用以下方式安装

$ pip install threedi-scenario-downloader

本项目本身的开发生态安装

我们使用常规pip和virtualenv安装。创建一个虚拟环境并调用pip

$ python3 -m venv venv
$ venv/bin/pip install -r requirements.txt

为了得到格式良好的Python文件，而无需手动工作，定期运行以下命令

$ venv/bin/ruff check threedi_scenario_downloader --fix
$ venv/bin/ruff format threedi_scenario_downloader

第一个命令还会报告类似语法错误的错误，您需要修复。

定期运行测试。这也检查覆盖率报告

$ venv/bin/pytest

在运行测试之前，在当前目录中创建一个名为test_api_key.txt的文件，并添加一个lizard API密钥。只需键入，一行。否则，测试会抱怨。在github action中，此.txt文件包含TEST_API_KEY github密钥。

需要新版本时联系Reinout，因为尚未自动上传到pypi，所以他必须上传。

如果您需要新的依赖项（如requests），在setup.py中的install_requires中添加它。之后，再次运行安装以实际安装您的依赖项

$ venv/bin/pip install -r requirements.txt