Skip to content

Commit 35c0af6

Browse files
committed
started docstr
1 parent 2e04e9e commit 35c0af6

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

zappend/levels.py

+14-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,20 @@ def write_levels(
2727
tile_size: tuple[int, int] | None = None,
2828
**zappend_config,
2929
):
30-
"""TODO - document me"""
30+
"""Writes a dataset at `source_path` to a xcube multi-level
31+
dataset at `target_path`.
32+
33+
The source dataset is opened and subdivided into dataset slices
34+
along the append dimension given by `append_dim`, which defaults to `"time"`.
35+
The slice size in the append dimension is one and also the target dataset's
36+
chunk size in the append dimension will be one.
37+
38+
Args:
39+
source_path: The source dataset path.
40+
source_storage_options: Storage options for the source
41+
dataset's filesystem.
42+
target_path:
43+
"""
3144
from xcube.core.tilingscheme import get_num_levels
3245
from xcube.core.gridmapping import GridMapping
3346
from xcube.core.subsampling import get_dataset_agg_methods

0 commit comments

Comments
 (0)