Release version 1.0.0

[davidorme]

Description

This PR is to merge the current state of develop into main and release version 1.0.0.

UPDATED: 2024-07-01

• I've merged all the develop changes up until today into this
• Run the TestPyPi only pre-release: https://test.pypi.org/project/pyrealm/1.0.0a5/
• Note that this steps back down to 1.0.0 - the patch version got bumped for no reason during the setup of the trusted publishing and the publication workflow and I think it makes no sense to skip releasing a real 1.0.0. We do have those 1.0.1alpha versions on TestPyPi, but only there.
• Rebuilt the docs on RTD: https://pyrealm.readthedocs.io/en/release-1.0.0/

The only real changes unique to this branch are:

• Updated CHANGES.txt to a better structured CHANGES.md with most recent at the top.
• Updated the pyproject.toml.
• Added the python 3.12 runners, which had been left off the switch to ruff and #226 and #220.

Closes #206

There was an odd message about not being up to date with main - I'm not sure what commits have snuck through onto main only. After merging main into this PR, I'm still none the wiser: it's a seemingly empty commit: 0fe305b

Type of change

• [x] New feature (non-breaking change which adds functionality)
• [x] Optimization (back-end change that speeds up the code)
• [x] Bug fix (non-breaking change which fixes an issue)

Key checklist

• [ ] Make sure you've run the pre-commit checks: $ pre-commit run -a
• [ ] All tests pass: $ poetry run pytest

Further checks

• [ ] Code is commented, particularly in hard-to-understand areas
• [ ] Tests added that prove fix is effective or that feature works

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 96.27660% with 35 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@ed29b96). Learn more about missing BASE report.

Files	Patch %	Lines
pyrealm/splash/splash.py	90.00%	10 Missing :warning:
pyrealm/pmodel/pmodel_environment.py	89.79%	5 Missing :warning:
pyrealm/core/water.py	94.87%	4 Missing :warning:
pyrealm/pmodel/jmax_limitation.py	93.44%	4 Missing :warning:
pyrealm/pmodel/optimal_chi.py	98.21%	3 Missing :warning:
pyrealm/constants/core_const.py	97.82%	2 Missing :warning:
pyrealm/pmodel/pmodel.py	93.93%	2 Missing :warning:
pyrealm/constants/base.py	75.00%	1 Missing :warning:
pyrealm/pmodel/scaler.py	96.29%	1 Missing :warning:
pyrealm/pmodel/subdaily.py	97.14%	1 Missing :warning:
... and 2 more

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #233 +/- ## ======================================= Coverage ? 95.24% ======================================= Files ? 28 Lines ? 1703 Branches ? 0 ======================================= Hits ? 1622 Misses ? 81 Partials ? 0 ```

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

[davidorme]

I've backed off the update to flake8: pytest-flake8 relies on flake8 <=4.0.1 and is now pretty outdated. There have been attempts to fix it, but those are now abandoned - the argument seems to be:

1. that pre-commit is a better place to run flake8 than in pytest so this is just duplicated effort and
2. use ruff anyway.

For the moment, I’ve left it with that early version of flake8 but we could just ditch pytest-flake8 here, whether or not we eventually ditch flake8 entirely. That would at least run the most recent flake8 across the pyrealm codebase for this release.

[davidorme]

And the approval triggered action has stalled again. I think it is something in this thread: https://stackoverflow.com/questions/52200096/github-pull-request-waiting-for-status-to-be-reported

[j-emberton]

And the approval triggered action has stalled again. I think it is something in this thread: https://stackoverflow.com/questions/52200096/github-pull-request-waiting-for-status-to-be-reported

There's lots of suggestions of what to try in that thread!

[davidorme]

And the approval triggered action has stalled again. I think it is something in this thread: https://stackoverflow.com/questions/52200096/github-pull-request-waiting-for-status-to-be-reported

There's lots of suggestions of what to try in that thread!

There sure are. I'm not sure the original use case is similar enough to ours to be sure what the cause is. I'm still not convinced the automatic checking is working as expected. That profiling run failed - some code is slower than the previous runs - but it hasn't stopped the merge process. It isn't clear how this should work properly - and frankly I don't really trust the runtime comparisons either as there is a lot of runner dependent stochasticity.

[j-emberton]

And the approval triggered action has stalled again. I think it is something in this thread: https://stackoverflow.com/questions/52200096/github-pull-request-waiting-for-status-to-be-reported

There's lots of suggestions of what to try in that thread!

There sure are. I'm not sure the original use case is similar enough to ours to be sure what the cause is. I'm still not convinced the automatic checking is working as expected. That profiling run failed - some code is slower than the previous runs - but it hasn't stopped the merge process. It isn't clear how this should work properly - and frankly I don't really trust the runtime comparisons either as there is a lot of runner dependent stochasticity.

I think its possible to write the profiling action to just give a warning if the code is slower than the threshold, but not fail the whole run