跳转到主要内容

将MITgcm的mds二进制文件读入xarray

项目描述

pypi package travis-ci build status code coverage documentation status DOI

xmitgcm是一个Python包,用于将MITgcm的二进制MDS文件读入xarray数据结构。通过在dask数组中存储数据,xmitgcm使得对MITgcm输出数据的并行、离核分析成为可能。

安装

要求

xmitgcm与Python 3.7及以上版本兼容。它需要xarray(>=版本0.11.0)和dask(>=版本1.0)。这些软件包最可靠地通过conda环境管理系统安装,该系统是Anaconda Python发行版的一部分。假设您的系统上已安装conda,可以使用以下命令安装依赖项:

conda install xarray dask

如果您正在使用这些软件包的早期版本,请在安装xmitgcm之前更新它们。

通过pip安装

如果您只想使用xmitgcm,最简单的方法是通过pip安装

pip install xmitgcm

这将自动从pypi安装最新版本。

从github安装

xmitgcm正在积极开发中。要获取最新开发版本,您可以克隆源存储库并安装它

git clone https://github.com/MITgcm/xmitgcm.git
cd xmitgcm
python setup.py install

鼓励用户分支xmitgcm并提交问题拉取请求

快速入门

首先确保您理解xarray数据集对象是什么。然后找到一些MITgcm MDS数据。如果您没有任何自己的数据,可以下载xmitgcm 测试存储库。要下载一些测试数据,运行以下shell命令:

$ curl -L -J -O https://ndownloader.figshare.com/files/6494718
$ tar -xvzf global_oce_latlon.tar.gz

这将创建一个名为global_oce_latlon的目录,我们将在此示例中使用该目录。如果您有自己的数据,请用您的mitgcm文件路径替换此路径。

要将MITgcm MDS数据作为xarray.Dataset打开,请在Python中执行以下操作:

from xmitgcm import open_mdsdataset
data_dir = './global_oce_latlon'
ds = open_mdsdataset(data_dir)

data_dir应该是到MITgcm运行目录的路径(绝对路径或相对路径)。xmitgcm将自动扫描此目录并尝试确定要读取的文件前缀和迭代次数。在某些配置中,open_mdsdataset函数可能不需要其他关键字参数即可正常工作。在大多数情况下,您必须指定更多详细信息。

有关更多详细信息,请参阅在线文档

项目详情


下载文件

下载适合您平台的可执行文件。如果您不确定选择哪一个,请了解有关安装软件包的更多信息。

源发行版

xmitgcm-0.5.2.tar.gz (6.3 MB 查看哈希值)

上传时间

构建发行版

xmitgcm-0.5.2-py3-none-any.whl (100.0 kB 查看哈希值)

上传时间 Python 3