Open mgrover1 opened 2 years ago
Related ESDS blogs
I'm working on a branch to address the
Add a "how to build a catalog"
tickbox. There's already a a question about it in the FAQ, though the answer is more of a non-answer... so I was going to start by updating that page with step-by-step instructions. Is that sufficient, or should there be a new page elsewhere in the docs as well?
I think a notebook in docs/source/user-guide
would suffice for the time being. We shall figure out where this belongs when we rearrange the docs...
I'm going to start working on "What is intake-esm doing with my data?"
Hi everyone, fyi, I also provide some tutorials here for dkrz catalogs. I also cover how to merge two catalogs.
Can I contribute with one of those? Do you know about activities for defining name templates for catalogs and a registry for catalogs?
Best, Fabi
Hi @wachsylon - sorry for the very delayed response. Those look like great tutorials!
Contributions are welcome - the repo we have been using for a registry of catalogs has been this repo https://github.com/NCAR/intake-esm-datastore .
We are taking a look at the PR you submitted there, hopefully getting feedback there + merging soon.
Just realized @wachsylon's tutorials cover topics that are worth including in intake-esm's proper documentation. Therefore, i'm re-opening this issue
@mgrover1, do you plan on covering the remaining tasks in this list? i'd be happy to help... just want make sure there's no duplication of efforts
Based on conversations regarding the recent changes, and user feedback, it would be good to do a review of our current documentation, finding areas for improvement. Examples include:
- [x] Add a "how to build a catalog"
- [ ] What is intake-esm doing with my data?
- [ ] What is a dictionary of datasets/collection?
- [x] How do I add a derived variable?
- [ ] How to disable aggregations in
to_dataset_dict()
- [ ] How to modify
groupby_attrs
at runtime- [ ] How to save a subsetted catalog
- [ ] Document the
skip_on_error
flag into_dataset_dict()
- [ ] How to load a single key via the
cat[key].to_dask()
- [ ] Guide on how to debug when things go wrong...
- [x] Overview chapter in User Guide fails to build (unique takes no arguments) #404
- [x] Switch over to the furo theme #412: furo theme
Based on this documentation system, we should cover
- Tutorials
- How to Guides
- Explanation
- Reference
@wachsylon, could i interest you in contribute a PR with some of the contents from your amazing tutorials? :) No pressure if you don't have time. i can help with this and would certainly credit you
Based on conversations regarding the recent changes, and user feedback, it would be good to do a review of our current documentation, finding areas for improvement. Examples include:
to_dataset_dict()
groupby_attrs
at runtime (#522 )skip_on_error
flag into_dataset_dict()
cat[key].to_dask()
(#522 )cat.keys_info()
to retrieve information about keys (#522 )Based on this documentation system, we should cover