xarray-simlab 0.5.0

简而言之

下面的康威生命游戏示例改编自 Jake VanderPlas 的这篇 博客文章。

1. 通过编写紧凑的Python类来创建新的模型组件，即非常类似于 dataclasses。

import numpy as np
import xsimlab as xs

@xs.process
class GameOfLife:
    world = xs.variable(
        dims=('x', 'y'), intent='inout', encoding={'fill_value': None}
    )

    def run_step(self):
        nbrs_count = sum(
            np.roll(np.roll(self.world, i, 0), j, 1)
            for i in (-1, 0, 1) for j in (-1, 0, 1)
            if (i != 0 or j != 0)
        )
        self._world_next = (nbrs_count == 3) | (self.world & (nbrs_count == 2))

    def finalize_step(self):
        self.world[:] = self._world_next


@xs.process
class Glider:
    pos = xs.variable(dims='point_xy', description='glider position')
    world = xs.foreign(GameOfLife, 'world', intent='out')

    def initialize(self):
        x, y = self.pos

        kernel = [[1, 0, 0],
                  [0, 1, 1],
                  [1, 1, 0]]

        self.world = np.zeros((10, 10), dtype=bool)
        self.world[x:x+3, y:y+3] = kernel

2. 只需提供一个模型组件的字典即可创建新的模型。

model = xs.Model({'gol': GameOfLife,
                  'init': Glider})

3. 创建一个输入 xarray.Dataset，运行模型并获取一个输出 xarray.Dataset。

input_dataset = xs.create_setup(
    model=model,
    clocks={'step': np.arange(9)},
    input_vars={'init__pos': ('point_xy', [4, 5])},
    output_vars={'gol__world': 'step'}
)

output_dataset = input_dataset.xsimlab.run(model=model)

>>> output_dataset
<xarray.Dataset>
Dimensions:     (point_xy: 2, step: 9, x: 10, y: 10)
Coordinates:
  * step        (step) int64 0 1 2 3 4 5 6 7 8
Dimensions without coordinates: point_xy, x, y
Data variables:
    init__pos   (point_xy) int64 4 5
    gol__world  (step, x, y) bool False False False False ... False False False

4. 使用方法链以函数式风格进行模型设置、预处理、运行、后处理和可视化。

import matplotlib.pyplot as plt

with model:
    (input_dataset
     .xsimlab.update_vars(
         input_vars={'init__pos': ('point_xy', [2, 2])}
     )
     .xsimlab.run()
     .gol__world.plot.imshow(
         col='step', col_wrap=3, figsize=(5, 5),
         xticks=[], yticks=[],
         add_colorbar=False, cmap=plt.cm.binary)
    )

文档

文档托管在 ReadTheDocs 上: http://xarray-simlab.readthedocs.io

许可证

3-clause（“修改”或“新”）BSD许可证，请参阅 许可证文件。

xarray-simlab使用了xarray、pandas和dask库的代码片段。xarray、pandas和dask的许可证在“licenses”目录中复现。

致谢

本项目的支持来自于GFZ赫尔姆霍兹研究中心地球表面过程建模小组。地球表面过程建模

引用

如果您在科学出版物中使用xarray-simlab，我们将非常感谢您的引用。