pyaerocom icon indicating copy to clipboard operation
pyaerocom copied to clipboard

Adds possibility for descriptions for obs and mod

Open dulte opened this issue 1 month ago • 1 comments

Change Summary

Adds option to model and obs entries where the user can add a description of that entry. This description will be passed all the way to the outputted config, where the frontend can pick it up

Checklist

  • [ ] Start with a draft-PR
  • [ ] The PR title is a good summary of the changes
  • [ ] PR is set to AeroTools and a tentative milestone
  • [ ] Documentation reflects the changes where applicable
  • [ ] Tests for the changes exist where applicable
  • [ ] Tests pass locally
  • [ ] Tests pass on CI
  • [ ] At least 1 reviewer is selected
  • [ ] Make PR ready to review

dulte avatar Nov 18 '25 10:11 dulte

Codecov Report

:x: Patch coverage is 94.28571% with 2 lines in your changes missing coverage. Please review. :white_check_mark: Project coverage is 78.39%. Comparing base (2abd82e) to head (208593c).

Files with missing lines Patch % Lines
pyaerocom/aeroval/experiment_output.py 85.71% 2 Missing :warning:
Additional details and impacted files
@@             Coverage Diff              @@
##           main-dev    #1766      +/-   ##
============================================
+ Coverage     78.36%   78.39%   +0.02%     
============================================
  Files           176      177       +1     
  Lines         23414    23448      +34     
============================================
+ Hits          18349    18381      +32     
- Misses         5065     5067       +2     
Flag Coverage Δ
unittests 78.39% <94.28%> (+0.02%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

: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 Nov 18 '25 10:11 codecov[bot]

Thanks. It would be good if we could get a documentation of the expected output somewhere. And maybe a test? Or full validated / pydantic output... It's Chrismas soon, so time for wishes :-)

I will try my hand on making a pydantic validation for this output :santa: Then we can (hopefully) start to define the rest of the output as well in other PRs

dulte avatar Dec 08 '25 09:12 dulte

@heikoklein I've added some pydantic models for menu.json if you want to have a look

dulte avatar Dec 16 '25 12:12 dulte

Thanks, nicely implemented validation in an external class.

I would have added a method 'return_validated()' to the output-model, just to hide any pydantic-interna - at some point (in 10 years?) we might want to switch to a different validation-framework.

heikoklein avatar Dec 17 '25 09:12 heikoklein