|
1 | 1 | # Configuration |
2 | 2 |
|
| 3 | +The quickest way to get started is to generate starter templates with the CLI: |
| 4 | + |
| 5 | +```bash |
| 6 | +deep-code generate-config # writes to current directory |
| 7 | +deep-code generate-config -o ./configs # custom output folder |
| 8 | +``` |
| 9 | + |
| 10 | +This creates `dataset_config.yaml` and `workflow_config.yaml` with all supported fields and placeholder values. Fill them in, then run [`deep-code publish`](cli.md#publish-metadata). |
| 11 | + |
| 12 | +The sections below document every field in those templates. |
| 13 | + |
| 14 | +--- |
| 15 | + |
3 | 16 | ## Dataset config (YAML) |
4 | 17 | ```yaml |
5 | 18 | # Required |
@@ -80,6 +93,7 @@ properties: |
80 | 93 | keywords: ["Earth Science"] |
81 | 94 | themes: ["cryosphere"] |
82 | 95 | license: proprietary |
| 96 | + # jupyter_kernel_info is optional — only published when jupyter_notebook_url is set |
83 | 97 | jupyter_kernel_info: |
84 | 98 | name: deepesdl-xcube-1.8.3 |
85 | 99 | python_version: 3.11 |
@@ -111,8 +125,8 @@ links: |
111 | 125 | | `properties.keywords` | No | List of keyword strings. | |
112 | 126 | | `properties.themes` | No | List of OSC theme slugs. | |
113 | 127 | | `properties.license` | No | License identifier (e.g. `proprietary`, `CC-BY-4.0`). | |
114 | | -| `properties.jupyter_kernel_info` | No | Kernel name, Python version, and environment file URL. | |
115 | 128 | | `jupyter_notebook_url` | No | Link to the source notebook on GitHub. When omitted, kernel and application links are skipped. | |
| 129 | +| `properties.jupyter_kernel_info` | No | Kernel name, Python version, and environment file URL. Only published when `jupyter_notebook_url` is set. | |
116 | 130 | | `contact` | No | List of contact objects with `name`, `organization`, and `links`. | |
117 | 131 | | `links` | No | Additional OGC API record links (e.g. `related`, `describedby`). | |
118 | 132 |
|
|
0 commit comments