Skip to content

Commit

Permalink
update tool specification
Browse files Browse the repository at this point in the history
  • Loading branch information
mmaelicke committed Feb 2, 2024
1 parent 4ac96ab commit 9fb204d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
5 changes: 4 additions & 1 deletion src/param.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,12 @@ class Params(BaseModel):

# optional parameter to configure output
keep_data_files: bool = True

database_name: str = 'dataset.db'

# optional parameter to provide result output
precision: str = 'day'
resolution: int = 5000

# stuff that we do not change in the tool
base_path: str = '/out'
netcdf_backend: NetCDFBackends = NetCDFBackends.XARRAY
Expand Down
27 changes: 24 additions & 3 deletions src/tool.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,30 @@ tools:
type: datetime
description: |
The end date of the datasetm, if a time dimension applies to the dataset.
# integrate dataset
# mode of operation
# keep intermediate files
integration:
type: enum
values:
- none
- all
- sptatial
- temporal
description: |
The mode of operation for the integration of each all data files associated to each data source
into a common DuckDB-based dataset. This dataset includes data for a unified spatial and temporal
extent and includes macros for aggregation. By setting `integration` the default integrations are
selected. The resulting database can still be used to query different aggregation levels.
- `none`: No integration will be performed and the DuckDB database will **NOT** be created.
- `all`: Temporal and spatial scale aggregations will be integrated, if the scale is defined in the dataset metadata.
- `spatial`: Only results for spatial aggregations will be provided.
- `temporal`: Only results for temporal aggregations will be provided.
optional: true
keep_data_files:
type: boolean
optional: true
description: |
If set to `false`, the data files clipped to the spatial and temporal scale as defined in the
data-source metadata will not be kept. This saves a lot of disk space for the output.
If set to `true` (default behavior), then there will be a `/out/datasets` directory in the output.
connection:
type: string
optional: true
Expand Down

0 comments on commit 9fb204d

Please sign in to comment.