Add FAQs page to docs #181
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add section for handling opening files with conflicting data var values
tomvothecoder
commented
Jan 10, 2022
tomvothecoder
commented
Jan 10, 2022
tomvothecoder
commented
Jan 10, 2022
Comment on lines
+1
to
+22
| ========================== | ||
| Frequently Asked Questions | ||
| ========================== | ||
|
|
||
| How do I open files that have conflicting values for a data variable(s)? | ||
| ------------------------------------------------------------------------ | ||
| In xarray, the default setting for checking compatibility across files is ``compat='no_conflicts'``. | ||
| If conflicting values for a data variable exists between the files, xarray raises ``MergeError: conflicting values for variable <DATA VAR NAME> on objects to be combined. You can skip this check by specifying compat="override".`` | ||
|
|
||
| Let's say you try opening two files using ``xcdat.open_mfdataset()`` and the aforementioned ``MergeError`` appears for the ``lat_bnds`` data var. | ||
| You perform floating point comparison for ``lat_bnds`` and find a very small difference at specific coordinates. | ||
|
|
||
| To workaround this data quality issue and proceed with opening the files, pass these keyword arguments: | ||
|
|
||
| 1. ``compat="override"``: skip comparing and pick variable from first dataset | ||
| 2. ``join="override"``: if indexes are of same size, rewrite indexes to be those of the first object with that dimension. Indexes for the same dimension must have the same size in all objects. | ||
|
|
||
| - ``join`` is set to `"outer_join"` by default, which might not be desired. | ||
|
|
||
| ``xcdat.open_mfdataset('path/to/files/*.nc', compat="override", join="override")`` | ||
|
|
||
| More information here: https://xarray.pydata.org/en/stable/generated/xarray.open_mfdataset.html#xarray-open-mfdataset |
There was a problem hiding this comment.
@pochedls Just an FYI
There was a problem hiding this comment.
This is great - thanks Tom!
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a page to the documentation for FAQs. It also adds a section to the FAQs for handling #162.
Checklist
If applicable: