Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Howto for adding datasets to intake catalog #91

Merged
merged 9 commits into from
Apr 26, 2024

Conversation

observingClouds
Copy link
Collaborator

@observingClouds observingClouds commented May 2, 2023

In order to make it easier for the community to add datasets to the EUREC4A intake catalog and the HowTo EUREC4A book this PR adds some documentation on how to do so.

@observingClouds
Copy link
Collaborator Author

@Geet-George @raphvog please have a look a this PR and suggest edits. Maybe you could even try to add your own or favourite missing dataset to the catalog and the how-to page to test the documentations.

@observingClouds observingClouds marked this pull request as ready for review September 7, 2023 10:28
Copy link
Contributor

@Geet-George Geet-George left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. :) I have never tried the web interface, so I'll leave that to your expertise.


Depending on the complexity of the dataset, an entry can be directly added to the `main.yaml` file of the respective platform/simulation
```bash
vi <platform>/main.yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it necessary to specify vim here (and in the following instances)? We could just say the file name and the user can use their means of populating the YAML.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just want to give an example here and vi should be installed on most platforms.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly that's true, but I had some recent issues on someone's machine which is why realised this. I think it might be Windows.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But I am not particularly hard and fast on this. If this is the only thing remaining, let's go... If there are issues, users would hopefully raise an issue.

how_to_eurec4a/howto.md Outdated Show resolved Hide resolved
how_to_eurec4a/howto.md Outdated Show resolved Hide resolved
how_to_eurec4a/howto.md Outdated Show resolved Hide resolved
@observingClouds
Copy link
Collaborator Author

Thanks for the comments @Geet-George! I implemented most of them. Please feel free to also use the ```suggestion``` annotation next time so I can just accept your suggestions :)

@Geet-George
Copy link
Contributor

Geet-George commented Sep 11, 2023

use the ```suggestion``` annotation next time so I can just accept your suggestions :)

Ah ja, sorry I forgot

@observingClouds observingClouds merged commit 24b2c66 into eurec4a:master Apr 26, 2024
2 checks passed
@observingClouds observingClouds deleted the howto branch April 26, 2024 18:37
@observingClouds observingClouds changed the title Howto for adding datasets to intake and the howtoeurec4a book Howto for adding datasets to intake catalog Apr 26, 2024
@observingClouds
Copy link
Collaborator Author

closes #106

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants