API changes: Field and FieldSet
#1709
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
- data - grid - lon - lat - depth - interp_method - gridindexingtype - cast_data_dtype - cell_edge_sizes
VeckoTheGecko
force-pushed
the
v/api-changes
branch
from
db3dc49 to
8d4ae8a
Compare
- get_dim_filenames() - collect_timeslices() - calc_cell_edge_sizes() - search_indices_vertical_z() - search_indices_vertical_s() - reconnect_bnd_indices() - search_indices_rectilinear() - search_indices_curvilinear() - search_indices() - interpolator2D() - interpolator3D() - ccode_eval() - ccode_convert() - get_block_id() - get_block() - chunk_setup() - chunk_data() - rescale_and_set_minmax() - data_concatenate() - spatial_interpolation()
- Field.dataFiles - Field.loaded_time_indices - Field.creation_log - Field.data_chunks - Field.c_data_chunks - Field.chunk_set - Field.reshape() - FieldSet.completed - Field.time_index() - FieldSet.check_complete()
Make FieldSet.add_UVfield() private and Field.dimensions read only
VeckoTheGecko
force-pushed
the
v/api-changes
branch
from
54a563a to
0e99bc2
Compare
erikvansebille
approved these changes
Sep 24, 2024
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.
Contributes to #1695
This PR makes many of the names in
FieldandFieldSet:All privatisations are done in a non-breaking way, raising a deprecation warning. I have also updated
conftest.pysuch that any deprecation warnings raised by Parcels result in a failure (meaning we don't accidentally call deprecated methods internally)There is some testing of these API changes (checking that calls to old attributes names return the privatised attribute, checking of the source code so that old calls now direct to the private versions). Methods aren't actually called as that would require designing test cases for each item.
The method/attributes affected are:
Other changes: