pyam icon indicating copy to clipboard operation
pyam copied to clipboard

Ixmp4/datetime

Open danielhuppmann opened this issue 7 months ago • 1 comments

Please confirm that this PR has done the following:

  • [x] Tests Added
  • ~Documentation Added~
  • ~Name of contributors Added to AUTHORS.rst~
  • [ ] Description in RELEASE_NOTES.md Added

Adding to RELEASE_NOTES.md (remove section after adding to RELEASE_NOTES.md)

Please add a single line in the release notes similar to the following:

- (#XX)[http://link-to-pr.com] Added feature which does something

Description of PR

This PR is a first step to support writing subannual (datetime) timeseries to an ixmp4 platform.

danielhuppmann avatar May 28 '25 07:05 danielhuppmann

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 95.1%. Comparing base (ddbb88e) to head (7b24f3a). :warning: Report is 56 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff           @@
##            main    #912    +/-   ##
======================================
  Coverage   95.0%   95.1%            
======================================
  Files         64      66     +2     
  Lines       6134    6399   +265     
======================================
+ Hits        5828    6086   +258     
- Misses       306     313     +7     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar May 28 '25 07:05 codecov[bot]

Thanks @phackstock

The release notes entry seems to be missing for now

Added

An entry to the docs page about firstly the datetime upload option and the datetime formatting rules would be good.

The documentation includes an explanation of the datetime use case, see the Data Model page. The to_ixmp4() documentation doesn't make any reference to the time domain, so this PR removes an undocumented NotImplementedError - so I would not make the documentation more complex than necessary.

As codecov points out, a test with a 'time' dimension with datetime and years combined would be good.

Tried to add a test for the mixed time-domain case and realized that ixmp4 does not support that yet - for now, I added a clear NotImplementedError in this PR. I suggest to merge this PR, then I'll see if I can fix ixmp4, and then extend to pyam to_ixmp4() functionality.

danielhuppmann avatar Jul 16 '25 13:07 danielhuppmann