pynusdas 0.0.5

Python interface for the JMA's NuSDaS format

pynus

A python library enabling to handle files in the NuSDaS format operationally used in the NWP systems in JMA.
You will find Japanese readme below.

Usage

Install using pip
I like the name "pynus", but this library is distibuted as "pynusdas" package in PyPI.

pip install pynusdas

Feed a NuSDaS file and get full xarray Datasets
decode_nusdas function returns you fully loaded xarray Datasets. This is handy when you want to simply convert the entire dataset into netcdf.

from pynus import decode_nusdas

mdls, surfs = decode_nusdas(f"./data/fcst_mdl.nus/ZSSTD1/200910070000")

mdls.to_netcdf(f"./data/MF10km_MDLL_200910070000.nc")
surfs.to_netcdf(f"./data/MF10km_SURF_200910070000.nc")

Lazy-loading with xarray using pynus as an engine
You can also use xr.open_dataset function with specifying engine='pynus' or engine='pynusdas'. More suitable when you handle a dataset intreactively e.g. in jupyter notebook.

mdls = xr.open_dataset(f"./data/fcst_mdl.nus/ZSSTD1/200910070000",
                          engine="pynus", chunks={"x": 19, "y": 17},)
print(mdls)

Disclaimer

This library is NOT an official project of JMA. Don't send any inquiries to JMA regarding this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgement

This work is inspired and partly coming from by the tutorial codes on the Laboratory of Meteorology website at Hokkaido University.
https://geodynamics.sci.hokudai.ac.jp/humet/meteo/tutorial.html

Japanese

pynusは気象庁の現業気象予報システムで使用されているNuSDaSフォーマットで記述されたファイルをpythonで簡便に読み込むことを目的としたライブラリです。

使いかた
PyPIでは "pynusdas" パッケージとして登録されているため以下のコマンドでインストールできます。

pip install pynusdas

NuSDaSファイルを丸ごと読み込む
decode_nusdas 関数にNuSDaSファイルのパスを渡すことで全ての変数をxarray datasetとして読み込みます。返されるデータセットは地上と大気成分に別れた2つのデータセットです。この関数はnetcdf形式への変換などデータセット全体に対し作業するときに便利です。

from pynus import decode_nusdas

mdls, surfs = decode_nusdas(f"./data/fcst_mdl.nus/ZSSTD1/200910070000")

mdls.to_netcdf(f"./data/MF10km_MDLL_200910070000.nc")
surfs.to_netcdf(f"./data/MF10km_SURF_200910070000.nc")

xarray.open_datasetを用いて逐次読み込む
xr.open_dataset関数の引数にengine="pynus"またはengine="pynusdas"を指定することでnetcdfファイルの読み込みと同じ感覚で作業することも可能です。Jupyter notebookでの描画などデータのごく一部のみを逐次読み出すときに便利です。

mdls = xr.open_dataset(f"./data/fcst_mdl.nus/ZSSTD1/200910070000",
                          engine="pynus", chunks={"x": 19, "y": 17},)
print(mdls)

免責事項
このライブラリの開発は気象庁および関連機関の業務とは一切関係がございません。気象庁および関係者の方へのこのライブラリに関する問い合わせはお控えください。

謝辞
ライブラリのコードは北海道大学気象学研究室のチュートリアルをベースにさせていただきました。ここに感謝を申し上げます。
https://geodynamics.sci.hokudai.ac.jp/humet/meteo/tutorial.html