sea-names 0.3.0

安装

此项目依赖于conda进行安装和管理项目依赖。

1. 下载并安装适用于您的操作系统的miniconda https://docs.conda.org.cn/en/latest/miniconda.html。

2. 使用git克隆此项目。

3. 一旦conda可用，请使用以下命令为该项目创建环境：

   conda env create -f environment.yml

   上述命令创建了一个名为sea-names的新conda环境，其中包含了必要的项目依赖。

4. 存在一个额外的环境文件，用于测试和开发环境。可以使用以下命令安装额外的开发依赖：

   conda env update -f test-environment.yml

5. 要将项目安装到新环境中

   conda activate sea-names
   pip install -e .

Shapefiles和Dataset使用

由于许可原因，我们已被要求删除该库使用的shapefiles存储库。库将保持公开访问，但作为库基础的dataset不再公开分发。

我们正在尝试使库使用开源dataset或为用户提供替代方案，对此造成的不便我们深表歉意。

运行测试

要运行项目的测试

pytest -sv --integration

用法

此包可以为任何给定的坐标对（经度，纬度）提供区域名称。

import sea_names

lon = -81.65
lat = 41.98

name = sea_names.get_sea_name((lon, lat))
assert name == "Lake Erie"

该软件包还具有为一系列点提供一组海洋名称的能力。这项功能仍处于实验阶段，可能会占用大量内存。

from sea_names.geo import get_sea_names_for_trajectory
lons = [
   -176.54,
   -164.70,
   -143.13,
   -126.09,
   -107.18,
   -91.36,
]
lats = [
   55.64,
   48.74,
   56.57,
   45.58,
   21.39,
   25.15,
]
region_names = get_sea_names_for_trajectory(lons, lats, chunk_size=len(lons))
assert region_names == ['Bering Sea', 'Gulf of Mexico', 'North Pacific Ocean']

配置

使用Docker构建

构建Docker容器

docker build -t sea-names .

使用Docker运行

致谢

本软件包是用Cookiecutter和audreyr/cookiecutter-pypackage项目模板创建的。

0.3.0 (2024-08-08)

• 更新README，包括使用示例

• 更新README，包括数据许可声明

• 更新数据集的哈希值

• 拼写纠正

0.2.0 (2024-06-21)

• 支持确定整个轨迹的海洋名称。

• 添加numpy到严格依赖项

0.1.0 (2023-06-16)

• 首次发布到PyPI。