Chunk Control documentation #5597
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
1 task
|
I think I've decided not to write code examples in the docstrings of each context manager, aside from "set". I could also remove them from the TP (only included as i felt it was less disruptive in full documentation). Open to disagreement though. |
trexfeathers
requested changes
Nov 22, 2023
trexfeathers
approved these changes
Nov 23, 2023
trexfeathers
merged commit 06d3eaf
into
SciTools:FEATURE_chunk_control
13 of 16 checks passed
ESadek-MO
added a commit
that referenced
this pull request
Nov 23, 2023
* Merge chunk control code into latest iris (#5565) * Dask chunking control for netcdf loading. * renamed loader * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix indentation error, perhaps also docstring error * fixed result error in loader, and set tests to treat as big files * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * trial and error, solve non iterable tuple 1.0 * trial and error, solve non iterable tuple 2.0 (used if var is none: instead of if var: ) * commented out docstring * fixed mock 'no name' failure * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fixed precommit issues * corrected docstrings as per review comments * Removed unnecessary line Co-authored-by: Martin Yeo <[email protected]> --------- Co-authored-by: Patrick Peglar <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Martin Yeo <[email protected]> * Chunk control modes (#5575) * added modes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * added as_dask mode * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * cleaned up enum and as_dask, as per review comments * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * corrected to in final place * unindented lazy_param assignment one indent --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Corrected required type of dimension_chunksizes. (#5581) * Chunk Control Tests (#5583) * converted tests to pytest, added neg_one, and incomplete from_file and as_dask tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * added from_file test * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * added mocking tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * trial and error with mocks and patches, may or may not work * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * converted Mock to patch in as_dask test * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * review comment changes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * pre commit fixes * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * review comments, and added test in test__get_cf_var_data() * added in another test * added tests and fixed review comments * added AuxCoord test --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Chunk control minor fixes (#5593) * Disallow chunks=None in optimum_chunksize. * Clearer docstrings. * Corrected docstring. * Chunk Control documentation (#5597) * init PR, skeleton TP * whoops, missed the TP. * fixed doctests in rst file * correct triple chevron to elipses * updated set doctest to better show functionality * removed in-progress doctest code * Review comments, part 1 * Review comments, part 2 * changed numpy docs dict * wait, this way is better * fixed linkcheck failures (maybe) * fixed :meth: * fixed a couple doc bits * hopefully fixed doctests * newest review comments * fixed rendering, and wording in docstring * fixed docstring numpyness * What's New Entry (#5601) * written whatsnew entry * added ref * moved label to before title --------- Co-authored-by: Elias <[email protected]> Co-authored-by: Patrick Peglar <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 task
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.
🚀 Pull Request
Closes #5400.
Added documentation, outlining the changes made in #5399 to implement further user control over chunksizes from
netcdf files.
21/11 *Note: This is very much WIP, and will go through many changes. The commits at time of PR creation
are consciously disorganized, unclear and dysfunctional.