Skip to content

Commit fe1787f

Browse files
committed
address reviewer's comments
1 parent d814b84 commit fe1787f

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

docs/config.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ This configures a dataset object from a single data source.
5555
* **[open_params](#open_params)**
5656
* **[format_id](#format_id)**
5757
* **[custom_processing](#custom_processing)**
58+
* * **[spatial_resample_params](#spatial_resample_params)**
59+
5860

5961
#### multi dataset object
6062
This configures a datasets from multiple data sources. Each [variable object](#variable-object) is
@@ -80,7 +82,7 @@ This configures a variable object, which is stored as a data variable within a s
8082
* **[data_id](#data_id)**
8183
* **[open_params](#open_params)**
8284
* **[custom_processing](#custom_processing)**
83-
85+
* * **[spatial_resample_params](#spatial_resample_params)**
8486

8587
### store object
8688
This configures a store object representing one xcube data store instance.
@@ -168,6 +170,14 @@ the data. It allows for custom dataset manipulation, making it particularly usef
168170
for handling unstructured datasets. The function must accept an `xarray.Dataset` as
169171
input and return a modified `xarray.Dataset` as output.
170172

173+
### spatial_resample_params
174+
This section enables user to define the parameters for spatial resampling of
175+
the dataset. For the supported params, please see [here](* * **[spatial_resample_params](#spatial_resample_params)**)
176+
177+
_NOTE_: The first 3 arguments `(source_ds, target_gm, source_gm)` in the `xcube_resampling.resample_in_space` are not
178+
required and will be inferred automatically from the config file's dataset and
179+
gridmapping section.
180+
171181
**Properties**:
172182

173183
* **module_path**: Path to the Python module relative to the config file.

0 commit comments

Comments
 (0)