Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v24.6 #395

Merged
merged 446 commits into from
Jul 8, 2024
Merged

v24.6 #395

merged 446 commits into from
Jul 8, 2024

Conversation

BradyPlanden
Copy link
Member

Description

Release v24.6

Issue reference

Fixes # (issue-number)

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

agriyakhetarpal and others added 30 commits May 8, 2024 02:04
This reverts commit 87cd2bb.
Re-enable testing on both macOS amd64 and macOS arm64
Install seed packages (`setuptools` and `wheel`)
…ite-time

Decrease test suite completion time
Adds a method to sample initial points within the
problem class, enabling a resample method within
SciPy.Minimize for an infinite initial cost, and
updating prior classes to have a shared base.
Add tests for the prior cls update and SciPyMinimize resampling.
Also updates sigma0 for GradientDescent and loosens assertion
@BradyPlanden
Copy link
Member Author

As discussed, the spm_parameterisation.py integration test fails on PyBaMM v23.9, which is acceptable for this release as we will be dropping support once PyBaMM v24.5 is released. Until then, PyBaMM v24.1 is the default pip version.

Copy link
Member

@NicolaCourtier NicolaCourtier left a comment

Choose a reason for hiding this comment

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

Many thanks @BradyPlanden, @agriyakhetarpal and @brosaplanella for all your contributions to this release!

This looks ready to go (noting the flaky integration tests with the older PyBaMM v23.9 which will soon be dropped).

Copy link

codecov bot commented Jul 8, 2024

Codecov Report

Attention: Patch coverage is 98.92328% with 16 lines in your changes missing coverage. Please review.

Project coverage is 97.78%. Comparing base (820cb77) to head (37a12bf).
Report is 1062 commits behind head on main.

Files with missing lines Patch % Lines
pybop/optimisers/base_optimiser.py 95.06% 4 Missing ⚠️
pybop/optimisers/base_pints_optimiser.py 98.23% 4 Missing ⚠️
pybop/problems/design_problem.py 88.46% 3 Missing ⚠️
pybop/optimisers/scipy_optimisers.py 98.05% 2 Missing ⚠️
pybop/_dataset.py 85.71% 1 Missing ⚠️
pybop/models/empirical/base_ecm.py 96.66% 1 Missing ⚠️
pybop/problems/fitting_problem.py 97.77% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #395      +/-   ##
==========================================
+ Coverage   95.33%   97.78%   +2.45%     
==========================================
  Files          36       43       +7     
  Lines        1971     2579     +608     
==========================================
+ Hits         1879     2522     +643     
+ Misses         92       57      -35     

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

@BradyPlanden BradyPlanden merged commit 6487bf1 into main Jul 8, 2024
51 of 64 checks passed
@BradyPlanden BradyPlanden deleted the v24.6 branch July 8, 2024 12:20
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.

4 participants