From a693f34b054dbe0ec4d0d72d1df3d2bd2fcd452f Mon Sep 17 00:00:00 2001 From: Hauke Schulz <43613877+observingClouds@users.noreply.github.com> Date: Mon, 1 May 2023 13:09:49 +0200 Subject: [PATCH] WIP: add section on GitHub interface --- how_to_eurec4a/howto.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/how_to_eurec4a/howto.md b/how_to_eurec4a/howto.md index 4bede8bb..63545354 100644 --- a/how_to_eurec4a/howto.md +++ b/how_to_eurec4a/howto.md @@ -92,3 +92,32 @@ Datasets should be added by following these steps: A pull request can be started on the GitHub webpage. After the pull request has been submitted, the review process will start. To accellerate the process, please make sure all tests for your pull request succeed. The status of the tests are shown at the bottom of your pull request. ### via GitHub web interface + +1. Visit EUREC$^4$A-Intake catalog repository + Go to [https://github.com/eurec4a/eurec4a-intake](https://github.com/eurec4a/eurec4a-intake) +2. Login with your GitHub credentials +3. Select the platform/simulation/product for which a new dataset entry shall be added + image +4. Edit image + `main.yaml` and add a reference to the dataset if it is simple and does not contain different subsets (e.g. resolutions, frequencies, sensors, dimensions): + ```yaml + plugins: + source: + - module: intake_xarray + + sources: + : + description: + driver: opendap + args: + auth: null + urlpath: + chunks: {} + engine: netcdf4 + ``` + (see 3. of **via command line** for more details +5. Save changes and create pull request + image +6. Check if the automatic tests that are run on your edits succeed. You can access the tests e.g. via the Action Tab (image +). +7. A reviewer will look at the pull request and will discuss any additional steps necessary to merge the changes to the main repository.