Is your feature request related to a problem? Please describe.
During today's COSIMA meeting mini-tutorial, a few issues cropped up that I thought I would suggest as documentation expansions/improvements. Some of these things are already in the access-nri-intake-catalog documentation, but could do to be teased out/expanded upon.
Describe the feature you'd like
The documentation currently explains how to use regex to search the catalog, but it doesn't point out that you can't use Unix-style wildcards (for example, doing "this*" does a substring search for "this", rather than looking for anything starting with "this"). This could be made more explicit (probably with a link to the Intake-ESM search instructions: https://intake-esm.readthedocs.io/en/latest/how-to/filter-catalog-by-substring-and-regex-criteria.html )
It would be good to explicitly point out that you can't really filter on time and/or coordinates until after you've created a dataset(s); that's an xarray job (although it should also be pointed out that the I/O penalty for this isn't too bad, given the actual data isn't touched until you go to make a calculation).
The diagram/flowchart under 'Using the catalog | Quickstart tutorial | Using the catalog' is detailed, but it may also be useful to provide a flowchart version showing the steps to take, including what to do at each step if you end up with a single or multiple datastores and/or datasets. (In effect, overtly show the different paths to take that are currently described as text between the coloured boxes.)
Is your feature request related to a problem? Please describe.
During today's COSIMA meeting mini-tutorial, a few issues cropped up that I thought I would suggest as documentation expansions/improvements. Some of these things are already in the
access-nri-intake-catalog
documentation, but could do to be teased out/expanded upon.Describe the feature you'd like
Describe alternatives you've considered
Nil.
Additional context
Nil.