Add wrapper for csg #286
Merged
Add wrapper for csg #286
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
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## main #286 +/- ##
==========================================
- Coverage 97.15% 97.07% -0.09%
==========================================
Files 49 51 +2
Lines 4748 4848 +100
==========================================
+ Hits 4613 4706 +93
- Misses 135 142 +7 ☔ View full report in Codecov by Sentry. |
3 tasks
mikapfl
reviewed
Nov 20, 2024
Use future implementation of stack in `nir_convert_df_to_long`
… start and end year.
mikapfl
requested changes
Mar 26, 2025
docs/source/usage/csg.md
Outdated
| The {py:func}`primap2.csg.compose` function creates a composite time series according to | ||
| the given priorities and strategies, but it does not take care of pre- and postprocessing | ||
| of the data. It will carry along unnecessary data and the resulting dataset will miss the | ||
| priority coordinates. The {py:func}`primap2.csg.create_composite_source` function takes acre |
There was a problem hiding this comment.
Suggested change
| priority coordinates. The {py:func}`primap2.csg.create_composite_source` function takes acre | |
| priority coordinates. The {py:func}`primap2.csg.create_composite_source` function takes care |
docs/source/usage/csg.md
Outdated
| define pre- and postprocessing: | ||
|
|
||
| * **result_prio_coords** Defines the vales for the priority coordinates in the output dataset. As the | ||
| priority coordinates differ for all input sources there is no canonical vale |
There was a problem hiding this comment.
Suggested change
| priority coordinates differ for all input sources there is no canonical vale | |
| priority coordinates differ for all input sources there is no canonical value |
docs/source/usage/csg.md
Outdated
|
|
||
| ``` | ||
|
|
||
| * **limit_coords** Optional parameter to remove data for coordinate vales not needed for the |
There was a problem hiding this comment.
Suggested change
| * **limit_coords** Optional parameter to remove data for coordinate vales not needed for the | |
| * **limit_coords** Optional parameter to remove data for coordinate values not needed for the |
docs/source/usage/csg.md
Outdated
|
|
||
| * **limit_coords** Optional parameter to remove data for coordinate vales not needed for the | ||
| composition from the input data. The time coordinate is treated separately. | ||
| * **time_range** Optional parameter to limit the time coverage of the input data. The input can either be pandas `DatetimeIndex` or a tuple of `str` or datetime-like in the form (year_from, year_to) where both boundaries are included in the range. Only the overlap of the supplied index or index created from the tuple with the time coordinate of the input dataset will be used. |
There was a problem hiding this comment.
Suggested change
| * **time_range** Optional parameter to limit the time coverage of the input data. The input can either be pandas `DatetimeIndex` or a tuple of `str` or datetime-like in the form (year_from, year_to) where both boundaries are included in the range. Only the overlap of the supplied index or index created from the tuple with the time coordinate of the input dataset will be used. | |
| * **time_range** Optional parameter to limit the time coverage of the input data. The input can either be a pandas `DatetimeIndex` or a tuple of `str` or datetime-like in the form (year_from, year_to) where both boundaries are included in the range. Only the overlap of the supplied index or index created from the tuple with the time coordinate of the input dataset will be used. |
mikapfl
reviewed
Mar 26, 2025
primap2/csg/__init__.py
Outdated
Comment on lines
26
to
27
| "create_time_index", | ||
| "set_priority_coords", |
There was a problem hiding this comment.
Do we need create_time_index and set_priority_coords in the public API? I'd think users only need to know about create_composite_source.
There was a problem hiding this comment.
Maybe there was an issue with imports when importing directly from the files but I'm not sure. I'll try if it works.
There was a problem hiding this comment.
Was no problem to change the import in the tests.
|
All suggestions accepted now |
CSG wrapper: small fixes
mikapfl
approved these changes
Mar 26, 2025
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
This PR adds a wrapper around the
primap2.csg.compose()function that prepares input data (e.g. remove unnecessary data) and postprocesses the output (add coordinates that were used in the process with new values).A larger test for the compose function as well a small test for a subfunction are added as well.
Docs will be extended.
Please confirm that this pull request has done the following:
{pr}.thing.mdfile in the directorychangelogadded - see changelog/README.md for detailsDescription
Please provide a short description what your pull request does.