Skip to content

Comments

Bugfixes and Tutorial Updates#124

Merged
kalebphipps merged 23 commits intomainfrom
bugfix/version_attribute
Jan 30, 2026
Merged

Bugfixes and Tutorial Updates#124
kalebphipps merged 23 commits intomainfrom
bugfix/version_attribute

Conversation

@kalebphipps
Copy link
Member

@kalebphipps kalebphipps commented Jan 24, 2026

Description

This PR includes several small bugfixes and improvements to documentation and tutorial:

  • The __version__ attribute is now included.
  • Documentation is updated to include a few more details (nothing major).
  • There is a new interactive tutorial notebook guiding users through the PAINT database.
  • The dataset loader has been made slightly more flexible to also load data directly from a pandas data frame.
  • A missing doctoring was included in the dataset splitter.
  • A boolean logic error was corrected in the heliostat download function of the STAC client which caused checkpoints never to be marked as complete.

NOTE: Instructions in the tutorial for installation via PyPi, specifically pip install "paint-csp[tutorial]" will not yet work, since this version of PAINT (i.e. the version with the tutorial dependencies) is a part of this PR. Therefore please perform a local clean install ``pip install ".[tutorial]" based off this branch when creating your environment for testing.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@github-actions
Copy link

github-actions bot commented Jan 24, 2026

Name Stmts Miss Cover Missing
paint/__init__.py 9 0 100%
paint/data/dataset.py 82 1 99% 18
paint/data/dataset_splits.py 155 1 99% 51
paint/preprocessing/__init__.py 15 0 100%
paint/preprocessing/binary_extractor.py 58 2 97% 80-89
paint/preprocessing/calibration_stac.py 10 0 100%
paint/preprocessing/catalog_stac.py 4 0 100%
paint/preprocessing/deflectometry_stac.py 10 0 100%
paint/preprocessing/dwd_mappings.py 14 0 100%
paint/preprocessing/dwd_stac_item.py 5 0 100%
paint/preprocessing/dwd_weather.py 45 1 98% 101
paint/preprocessing/focal_spot_extractor.py 74 4 95% 85, 92, 116, 273
paint/preprocessing/heliostat_catalog_stac.py 19 2 89% 40, 48
paint/preprocessing/juelich_weather_converter.py 51 3 94% 59, 111-114
paint/preprocessing/juelich_weather_mappings.py 34 0 100%
paint/preprocessing/juelich_weather_stac_item.py 6 0 100%
paint/preprocessing/properties_stac.py 11 0 100%
paint/preprocessing/target_cropper.py 54 1 98% 205
paint/preprocessing/tower_measurements.py 48 0 100%
paint/preprocessing/tower_stac.py 5 0 100%
paint/preprocessing/weather_collection_stac.py 5 0 100%
paint/util/__init__.py 28 0 100%
paint/util/gauss_kruger_converter.py 9 0 100%
paint/util/paint_mappings.py 581 0 100%
paint/util/preprocessing.py 32 0 100%
paint/util/utils.py 34 2 94% 111-112
TOTAL 1398 17 99%

@codecov
Copy link

codecov bot commented Jan 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.85%. Comparing base (fd4989e) to head (c8f7ffd).
⚠️ Report is 24 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #124      +/-   ##
==========================================
+ Coverage   98.84%   98.85%   +0.01%     
==========================================
  Files          26       26              
  Lines        1384     1398      +14     
==========================================
+ Hits         1368     1382      +14     
  Misses         16       16              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

@kalebphipps kalebphipps marked this pull request as ready for review January 24, 2026 00:42
@kalebphipps kalebphipps marked this pull request as draft January 24, 2026 00:44
@kalebphipps kalebphipps self-assigned this Jan 25, 2026
@kalebphipps kalebphipps marked this pull request as ready for review January 25, 2026 19:26
@kalebphipps kalebphipps requested a review from mcw92 January 25, 2026 19:26
Copy link
Member

@mcw92 mcw92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! The tutorial was easily understandable and everything worked out of the box as described in the notebook. I made some small changes in the notebook that I already committed. For the other files, I made commit suggestions (and also some comments in general) which should be addressed before merging.
I however already approve the PR.

@kalebphipps kalebphipps merged commit 483b26a into main Jan 30, 2026
12 checks passed
@mcw92 mcw92 deleted the bugfix/version_attribute branch February 2, 2026 07:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants