Remove science components from framework #46
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
added 5 commits
June 18, 2021 13:01
- move components/component.py to component.py - move components/_utils/* to _utils/* - rename records.py to record.py - rename states.py to state.py
was based on former subpackage components also refactored test package to reflect the new organisation of the cm4twc package
added 8 commits
June 23, 2021 16:21
Old *info* properties used to return references to the internal dictionaries used to define the components, which was dangerous because the user could modify them inadvertently, so they are replaced by *metadata* properties that return a string displaying the content of these dictionaries. In addition, *info* properties are kept for inwards/outwards (because required for Exchanger and Data/NullComponent), but they return a deep copy of the dictionaries to avoid accidentally modifying them internally.
Turn them into methods rather than properties, and add "requires" to them to be more explicit and to avoid confusion with SpaceDomain properties (land_sea_mask and flow_direction).
|
Some tests are going to fail, these are due to changes in the construct access API in In fact tests have been failing for a while, but since the |
|
I am intentionally cancelling the testing workflow as we know they are going to fail, and they took 3 days to complete last time around. |
added 5 commits
June 30, 2021 18:08
yaml.dump would return {} rather than an empty string or None, so here it will return None if the dictionary is empty
ThibHlln
pushed a commit
to ThibHlln/unifhy
that referenced
this pull request
Sep 27, 2021
Since unifhy-org#46, the component contributions are expected to inherit not only the framework component classes, but their names as well (i.e. SurfaceLayerComponent, SubSurfaceComponent, OpenWaterComponent). When "printing" a Model instance, the information displayed became irrelevant, as the class name would not allow to tell which science component is actually being used. This is now fixed by displaying the full module name containing the component class.
Merged
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.
resolve #45
The science components are removed from the package. The subpackage
componentsonly contained module component.py and its utils, so the module is moved to package root, and its utils are put with the other package utils.The existing science components now live in their own repositories:
The dummy components remain in the package to run the tests.
The documentation is updated to reflect the externalisation of the science components, including a review of the workflows to share science component contributions.
A template for component contribution now exists:
This PR also includes some API changes:
Componentet al. move fromcm4twc.componentstocm4twc.componentComponentclass attributes_land_sea_maskand_flow_directionbecome class attributes_requires_land_sea_maskand_requires_flow_direction, respectivelyMetaComponentclass propertiesland_sea_maskandflow_directionbecome class methodsrequires_land_sea_mask()andrequires_flow_direction()MetaComponentclass properties to explore component's definition (e.g.inwards_info,inputs_info, etc.) becomeinwards_metadata,inputs_metadata, etc.