CAOM2.5 (CADC-13449)

[andamian]

This commit includes:

• CAOM2.5 changes according to the model at https://github.com/pdowler/CAOM/blob/main/src/main/resources/draft-CAOM-2.5.png
• Changes in the checksum calculations: rename variables to be consistent with the model, remove wrapper/utility classes that are not part of the model, etc.

[SharonGoliath]

Well done!
Other general comments:

1. setup.cfg specifies 120 length line width, but none of the changes make use of it.
2. should the code use f-strings instead of format?
3. the file encodings can be removed
4. When going from 2.3 to 2.4, in the Plane class, there was some effort to keep both the energy_bands (2.4) and the em_bands (2.3) version of the metadata in the Plane class. There has been no work of that kind for the 2.4 -> 2.5 transition. Is that on purpose?

[codecov]

Codecov Report

Attention: Patch coverage is 92.21835% with 67 lines in your changes missing coverage. Please review.

Project coverage is 93.20%. Comparing base (e9b122e) to head (a51b294).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
caom2/caom2/obs_reader_writer.py	92.75%	25 Missing ⚠️
caom2/caom2/plane.py	93.63%	14 Missing ⚠️
caom2/caom2/artifact.py	74.28%	9 Missing ⚠️
caom2utils/caom2utils/polygonvalidator.py	37.50%	5 Missing ⚠️
caom2/caom2/checksum.py	91.30%	4 Missing ⚠️
caom2/caom2/dali.py	93.33%	3 Missing ⚠️
caom2/caom2/shape.py	81.81%	2 Missing ⚠️
caom2/caom2/caom_util.py	90.00%	1 Missing ⚠️
caom2/caom2/chunk.py	95.65%	1 Missing ⚠️
caom2/caom2/observation.py	98.00%	1 Missing ⚠️
... and 2 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #186      +/-   ##
==========================================
- Coverage   93.56%   93.20%   -0.37%     
==========================================
  Files          26       27       +1     
  Lines        8678     8914     +236     
==========================================
+ Hits         8120     8308     +188     
- Misses        558      606      +48     

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

[andamian]

Well done! Other general comments:

1. setup.cfg specifies 120 length line width, but none of the changes make use of it.
2. should the code use f-strings instead of format?
3. the file encodings can be removed
4. When going from 2.3 to 2.4, in the Plane class, there was some effort to keep both the energy_bands (2.4) and the em_bands (2.3) version of the metadata in the Plane class. There has been no work of that kind for the 2.4 -> 2.5 transition. Is that on purpose?

Thank you for going through all of it.

1. I've avoided formatting changes. This was a big PR even without that.
2. That's a good point. We should do it automatically with a tool (flynt) but avoid unnecessary code review.
3. Done
4. I didn't pay particular attention to those attributes but it looks to me that 2.5 should behave similar to 2.4 in that case but maybe I'm missing something. What makes you think it's not the case?

[SharonGoliath]

Making blazing progress!

For number 4 from my original general comments, I was more wondering whether there was ever any consideration of being backwards compatible with constructors? I'm just checking to make sure that "no" was a decision and not an oversight.

[andamian]

Pushed to the CAOM25 feature branch via #189