Skip to main content

Downloader for meteorological and ocean datasets

Project description

climdatapy

気象・海洋のデータセットをダウンロードするCLI/Pythonパッケージ。

Installation

Python 3.14以上が必要。

pipコマンドを使い、PyPIからインストールする。

$ pip install climdatapy

Usage

CLI

climdataコマンドでデータセットを管理する。

ダウンロード可能データセットを表示

$ climdata list

データセットをダウンロード

(例) 2024年1月1日から1月2日までのJRA3Qデータをダウンロードする。

$ climdata download JRA3Q --start_time 2024-01-01 --end_time 2024-01-02 --out ./JRA3Q --logfile jra3q.log

引数の説明は-hオプションで確認できる。

$ climdata download -h
usage: climdata download [-h] --start_time START_TIME --end_time END_TIME [--out OUT] [--logfile LOGFILE] dataset

Download files for a specified dataset and time range.

positional arguments:
  dataset               dataset name

options:
  -h, --help            show this help message and exit
  --start_time START_TIME
                        start date (YYYY-MM-DD)
  --end_time END_TIME   end date (YYYY-MM-DD)
  --out OUT             output directory
  --logfile LOGFILE     logfile path

最新データをダウンロード

(例) 公開されている最新のJRA3Qデータをダウンロードする。

$ climdata update JRA3Q --out ./JRA3Q --logfile jra3q.log

引数の説明は-hオプションで確認できる。

$ climdata update -h
usage: climdata update [-h] [--out OUT] [--logfile LOGFILE] dataset

positional arguments:
  dataset            dataset name

options:
  -h, --help         show this help message and exit
  --out OUT          output directory
  --logfile LOGFILE  logfile path

Pythonモジュール

各データセットは、抽象基底クラスclimdata.util.Datasetを継承したデータセット管理クラス(以下、管理クラス)を持つ。

climdatapy.get_manager関数で管理クラスを取得する。

import climdatapy

manager = climdatapy.get_manager("JRA3Q")

dowloadメソッド

任意の時間の範囲、変数などを選択し、ダウンロードする。

(例)

start_time = datetime(2025, 1, 1, 0)
end_time = datetime(2025, 1, 1, 6)
download_kw = {
    "stats_type": ["all"],
    "data_kind": ["all"],
    "near_realtime": ["all"],
    "stats_type": ["all"],
    "std": ["true"],
    "var": ["all"],
}

data_dir = Path("./data_new")
log_file_path = Path("./jra3q.log")

manager.download(
    start_time,
    end_time,
    download_kw,
    data_dir,
    log_file_path,
    exist_ok=True,
)

download_kwはデータセット固有の設定すべき情報を辞書型で確認する。

download_allメソッド

指定できる最大限のdownload_kwdownloadメソッドに与えるwrapper。

updateメソッド

取得できる最新の時刻のデータをダウンロードする。

(例)

manager.update(
    download_kw,
    data_dir,
    log_file_path,
    exist_ok=True,
)

update_allメソッド

指定できる最大限のdownload_kwupdateメソッドに与えるwrapper。

対応データセット

  • JRA3Q

Author

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

climdatapy-0.1.1.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

climdatapy-0.1.1-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file climdatapy-0.1.1.tar.gz.

File metadata

  • Download URL: climdatapy-0.1.1.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for climdatapy-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0a56d837487bc4d5c452b1162343bca8965155d28988ee72090c8aaef608833a
MD5 0a93606c0b9a9cd7c39f5b9ffcaaedc8
BLAKE2b-256 9df193f7041d7d20ca25bb0c2620406f01b1c8875efd579fd9895670ef05b49d

See more details on using hashes here.

Provenance

The following attestation bundles were made for climdatapy-0.1.1.tar.gz:

Publisher: publish.yml on sotomita/climdatapy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file climdatapy-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: climdatapy-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for climdatapy-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8b09bf0d05c9de3f32634d774a17e159f9749c91597372d5f5bb28eed3ac77a7
MD5 c3ddb78dc6840e9e1776af9442fc0f80
BLAKE2b-256 24d02058e61bb63da2acf3c633f8ab325a05b9401f577f0d3710e3e171bade91

See more details on using hashes here.

Provenance

The following attestation bundles were made for climdatapy-0.1.1-py3-none-any.whl:

Publisher: publish.yml on sotomita/climdatapy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page