Skip to content

Commit 8b29f13

Browse files
committed
update README.md
1 parent 69d4848 commit 8b29f13

File tree

1 file changed

+19
-28
lines changed

1 file changed

+19
-28
lines changed

README.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -56,25 +56,26 @@ pytest --cov-report html --cov=deep-code
5656
providing different utility functions.
5757
Use the --help option with these subcommands to get more details on usage.
5858

59-
The CLI retrieves the Git username and personal access token from a hidden file named .gitaccess. Ensure this file is located in the same directory where you execute the CLI
59+
The CLI retrieves the Git username and personal access token from a hidden file named
60+
.gitaccess. Ensure this file is located in the same directory where you execute the CLI
6061
command.
6162

63+
#### .gitaccess example
64+
65+
```
66+
github-username: your-git-user
67+
github-token: personal access token
68+
```
69+
6270
### deep-code publish
6371

64-
Publish the experiment, workflow and dataset which is a result of an experiment to
72+
Publish the experiment, workflow and dataset which is a result of an experiment to
6573
the EarthCODE open-science catalog.
6674

6775
```commandline
6876
deep-code publish /path/to/dataset-config.yaml /path/to/workflow-config.yaml
6977
```
7078

71-
#### .gitaccess example
72-
73-
```
74-
github-username: your-git-user
75-
github-token: personal access token
76-
```
77-
7879
#### dataset-config.yaml example
7980

8081
```
@@ -92,36 +93,26 @@ cf_parameter:
9293
- name: hydrology
9394
```
9495

95-
dataset-id has to be a valid dataset-id from `deep-esdl-public` s3 or your team bucket.
96+
dataset-id has to be a valid dataset-id from `deep-esdl-public` s3 bucket or your team
97+
bucket.
9698

97-
```
9899
#### workflow-config.yaml example
99100

100101
```
101-
workflow_id: "4D Med hydrology cube generation"
102+
workflow_id: "esa-cci-permafrost"
102103
properties:
103-
title: "Hydrology cube generation recipe"
104-
description: "4D Med cube generation"
104+
title: "ESA CCI permafrost"
105+
description: "cube generation workflow for esa-cci-permafrost"
105106
keywords:
106107
- Earth Science
107108
themes:
108-
- Atmosphere
109-
- Ocean
110-
- Evaporation
109+
- cryosphere
111110
license: proprietary
112111
jupyter_kernel_info:
113-
name: deepesdl-xcube-1.7.1
112+
name: deepesdl-xcube-1.8.3
114113
python_version: 3.11
115-
env_file: https://git/env.yml
116-
links:
117-
- rel: "documentation"
118-
type: "application/json"
119-
title: "4DMed Hydrology Cube Generation Recipe"
120-
href: "https://github.com/deepesdl/cube-gen/tree/main/hydrology/README.md"
121-
- rel: "jupyter-notebook"
122-
type: "application/json"
123-
title: "Workflow Jupyter Notebook"
124-
href: "https://github.com/deepesdl/cube-gen/blob/main/hydrology/notebooks/reading_hydrology.ipynb"
114+
env_file: "https://github.com/deepesdl/cube-gen/blob/main/Permafrost/environment.yml"
115+
jupyter_notebook_url: "https://github.com/deepesdl/cube-gen/blob/main/Permafrost/Create-CCI-Permafrost-cube-EarthCODE.ipynb"
125116
contact:
126117
- name: Tejas Morbagal Harish
127118
organization: Brockmann Consult GmbH

0 commit comments

Comments
 (0)