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

Release v24.9.0 #4408

Merged
merged 91 commits into from
Sep 3, 2024
Merged

Release v24.9.0 #4408

merged 91 commits into from
Sep 3, 2024

Conversation

kratman
Copy link
Contributor

@kratman kratman commented Sep 3, 2024

Release v24.9.0

This is the first release using the new process, this branch will be merged into main, then the release will be created from main.

Fixes #4400

kratman and others added 30 commits June 26, 2024 09:50
* Sync workflow

* Remove caching

* Switch order of commands

* Fix lychee

* Remove self-hosted runners

* Apply suggestions from code review

Co-authored-by: Agriya Khetarpal <[email protected]>

---------

Co-authored-by: Agriya Khetarpal <[email protected]>
* time varying experiment steps

* Update CHANGELOG.md

* fix code coverage

* rearrange function order

* remove `is_drive_cycle` attribute

* break out `record_tags` method

---------

Co-authored-by: Eric G. Kratz <[email protected]>
* Add OptionError if SEI in cracks selected but no cracks in mechanics

* Add test

---------

Co-authored-by: Robert Timms <[email protected]>
Co-authored-by: Eric G. Kratz <[email protected]>
* Moving test_util.py to pytest

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* Update pyproject.toml

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update pyproject.toml

Co-authored-by: Agriya Khetarpal <[email protected]>

* removed usless coment and entrypoint

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* Update tests/unit/test_util.py

Co-authored-by: Arjun Verma <[email protected]>

* Update tests/unit/test_util.py

Co-authored-by: Arjun Verma <[email protected]>

* Update tests/unit/test_util.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* Added suggestions and class structure back

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

---------

Signed-off-by: Pradyot Ranjan <[email protected]>
Co-authored-by: Pradyot Ranjan <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Agriya Khetarpal <[email protected]>
Co-authored-by: Arjun Verma <[email protected]>
…#4209)

* Make function for handling time or reuse an existing one
Fixes pybamm-team#4113

* style: pre-commit fixes

* fixing raises RegEx Error Experiment Test

* fix pre-commit error

* Update pybamm/callbacks.py

Co-authored-by: Eric G. Kratz <[email protected]>

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Agriya Khetarpal <[email protected]>
Co-authored-by: Valentin Sulzer <[email protected]>
Co-authored-by: Eric G. Kratz <[email protected]>
* Added contact resistance to model. Needs to be tested.

* style: pre-commit fixes

* Fixed code syntax

* style: pre-commit fixes

* Contact resistance added to lumped model, taken out of base_thermal

* style: pre-commit fixes

* Minor fix

* Added unit and integration tests

* style: pre-commit fixes

* Updated the thermal mdoels jupyter notebook with contact resistance example

* style: pre-commit fixes

* Updated to test total array rather than average of array

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Eric G. Kratz <[email protected]>
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.4.10 → v0.5.0](astral-sh/ruff-pre-commit@v0.4.10...v0.5.0)
- [github.com/adamchainz/blacken-docs: 1.16.0 → 1.18.0](adamchainz/blacken-docs@1.16.0...1.18.0)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Bump to v24.5rc0

* Update publish_pypi.yml

* Remove T flag

---------

Co-authored-by: Saransh-cpp <[email protected]>
Co-authored-by: Eric G. Kratz <[email protected]>
* Moving a bunch of integration test files to pytest

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

---------

Signed-off-by: Pradyot Ranjan <[email protected]>
Co-authored-by: Pradyot Ranjan <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Arjun Verma <[email protected]>
Co-authored-by: Agriya Khetarpal <[email protected]>
* Create scorecard.yml for continuous fuzzing with OSS-Fuzz

Integrating Google's OSS-Fuzz platform.
GSoC

* Update README.md

Add scorecard badge to display security score

* Update README.md

Add scorecard badge

* Update .github/workflows/scorecard.yml

Run on the main branch.

* Update .github/workflows/scorecard.yml

Run tests at 3:35 AM every Friday
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.5.0 → v0.5.1](astral-sh/ruff-pre-commit@v0.5.0...v0.5.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Bumps the actions group with 3 updates: [actions/upload-artifact](https://github.com/actions/upload-artifact), [ossf/scorecard-action](https://github.com/ossf/scorecard-action) and [github/codeql-action](https://github.com/github/codeql-action).


Updates `actions/upload-artifact` from 3.pre.node20 to 4.3.4
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@v3-node20...v4.3.4)

Updates `ossf/scorecard-action` from 2.3.1 to 2.3.3
- [Release notes](https://github.com/ossf/scorecard-action/releases)
- [Changelog](https://github.com/ossf/scorecard-action/blob/main/RELEASE.md)
- [Commits](ossf/scorecard-action@0864cf1...dc50aa9)

Updates `github/codeql-action` from 3.24.9 to 3.25.11
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@1b1aada...b611370)

---
updated-dependencies:
- dependency-name: actions/upload-artifact
  dependency-type: direct:production
  dependency-group: actions
- dependency-name: ossf/scorecard-action
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: actions
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: actions
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Update test pypi

* Style fix
* make longer default duration and calculate it for C-rate

* add tests

* typo

* pybamm-team#4224 add warning for time termination and add abs

* fix tests

* pybamm-team#4224 keep non-C-rate default at 24h for performance reasons

* trying to fix experiment

* fix example

* pybamm-team#4224 eric comments

* fix bug
* Fix CodeCov GHA workflow failure (pybamm-team#3845)

This amends the tag for the CodeCov GitHub Action from `4.1.0` to `v4.1.0`. This was a Dependabot error

* Begin refactor IDAKLU solver to support generalisable expressions [i.e. support more than just casadi functions]

* Continue refactor; compiles but with dlopen error on load; committing to test on another machine

* Refactor: Introduce Expression and ExpressionSet classes

* Restructure Expressions with generics folder and implementation-specific subfolders

* Separate Expression classes

* Template Expression class

* WIP: Subclass expressions (remove templates in order to generalise execution framework)

* Subclass expressions and remove unnecessary template arguments

* Isolate casadi functionality to Expression subclasses

* Add IREE expressions class

* Remove breakpoints

* Map input arguments to (reduced) call signature in MLIR

* Add support for inputs

* Support sensitivities

* Pre-commit

* Support output_variables

* Fix designator order error on linux; remove reference to ninja

* OS-invariant library loading

* Convert some pointer arrays to vectors; fixes sporadic crashes

* Fix bad memory allocations

* Tidy-up code

* Tidy up code

* Resolve jax/iree version numbers

* Conditional compilation of iree code

* Fix compiler variables

* Update noxfile sources list

* Pre-commit

* Make IREE tests conditional on IREE install

* Enable IREE in CI unit/integration testing

* Make demotion optional in idaklu_solver.py (still unsupported by IDAKLU)

* style: pre-commit fixes

* Fix expression tree test given change to bracketed expressions

* Codacy corrections and suppressions

* Enable IREE in unit testing

* style: pre-commit fixes

* Enable IREE in coverage testing

* Restrict IREE install to supported MacOS/Python versions

* Restrict IREE supported macOS installs

* Additional tests for IREE (demotion, output_variables, sensititivies)

* style: pre-commit fixes

* Additional tests (improve test coverage)

* Fix IREE unit test

* Fix sensitivities-sparsity bug; improve tests

* Fix tests

* Improve coverage

* Improve coverage (indirect)

* Suppress IREE warning on reload

* style: pre-commit fixes

* Fix codacy warning

* Fix noxfile docstring

* Update noxfile.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update pyproject.toml

Co-authored-by: Agriya Khetarpal <[email protected]>

* style: pre-commit fixes

* Update pybamm/solvers/c_solvers/idaklu.cpp

Co-authored-by: Martin Robinson <[email protected]>

* Update pybamm/solvers/c_solvers/idaklu/Expressions/IREE/IREEFunctions.cpp

Co-authored-by: Martin Robinson <[email protected]>

* Try removing no-cover from expression_tree/function.py

* Remove C from class name

* Clarify Base Expression docstrings

* Remove build-time iree.compiler search in CMakeLists.txt

* Add install note to iree-compiler in pyproject.toml

* Add IREE dependencies to docs

* style: pre-commit fixes

* Refactor MLIR parsing into ModuleParser class

* style: pre-commit fixes

* Add codacy hints

* Codacy fix

* Remove no-cover statements

* style: pre-commit fixes

* Coverage fix

---------

Co-authored-by: Ferran Brosa Planella <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Agriya Khetarpal <[email protected]>
Co-authored-by: Martin Robinson <[email protected]>
pybamm-team#4268)

Bumps the actions group with 1 update: [github/codeql-action](https://github.com/github/codeql-action).


Updates `github/codeql-action` from 3.25.11 to 3.25.12
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@b611370...4fa2a79)

---
updated-dependencies:
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: actions
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.5.1 → v0.5.2](astral-sh/ruff-pre-commit@v0.5.1...v0.5.2)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Moving a bunch of unit tests to pytest

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* style fix

Signed-off-by: Pradyot Ranjan <[email protected]>

* Update tests/unit/test_models/test_full_battery_models/test_lithium_ion/test_mpm_half_cell.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update tests/unit/test_models/test_full_battery_models/test_lithium_ion/test_spm.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update tests/unit/test_models/test_full_battery_models/test_lithium_ion/test_spme.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update tests/unit/test_parameters/test_parameter_sets_class.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update tests/unit/test_parameters/test_parameter_sets_class.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* Update tests/unit/test_plotting/test_plot.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* adding skips

Signed-off-by: Pradyot Ranjan <[email protected]>

* Update tests/unit/test_plotting/test_plot.py

Co-authored-by: Agriya Khetarpal <[email protected]>

* adding reason for skips

Signed-off-by: Pradyot Ranjan <[email protected]>

---------

Signed-off-by: Pradyot Ranjan <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Agriya Khetarpal <[email protected]>
* Using tempfile for standard_model_test

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

---------

Signed-off-by: Pradyot Ranjan <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
…bamm-team#4163)

* fix degradation options when one of the phases has no degradation

* skip Newman Tobias test

---------

Co-authored-by: Eric G. Kratz <[email protected]>
Co-authored-by: Arjun Verma <[email protected]>
…#4236)

* Removing flase flagging of assert statements from tests

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* Using ruff to check for asserts

Signed-off-by: Pradyot Ranjan <[email protected]>

* Using TypeError instead of assert

Signed-off-by: Pradyot Ranjan <[email protected]>

* Adding back bandit file

Signed-off-by: Pradyot Ranjan <[email protected]>

* style: pre-commit fixes

* Adding tests

Signed-off-by: Pradyot Ranjan <[email protected]>

---------

Signed-off-by: Pradyot Ranjan <[email protected]>
Co-authored-by: Pradyot Ranjan <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Eric G. Kratz <[email protected]>
kratman and others added 11 commits August 27, 2024 13:38
* Rename have_jax to has_jax

* Remove some extra stuff

* Update changelog

* style: pre-commit fixes

* Update changelog

* Remove has_jax

* Fix typo

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Update error handling

* Minor updates

* Update src/pybamm/citations.py

* Update citations.py

* Update tests
* add surface temperature equal to ambient temperature

* pybamm-team#4022 surface model works

* update temperature comparison script

* pybamm-team#4022 update tests and example, rename parameters

* fix plot_thermal_components

* fix unit tests

* pybamm-team#4022 fix lead acid thermal tests

* pybamm-team#4022 fix example

* coverage

* fix test

* style

* Moving missed files

* Rob's suggestion

---------

Co-authored-by: Eric G. Kratz <[email protected]>
Co-authored-by: kratman <[email protected]>
* time stepping updates

* Update test_idaklu_solver.py

* Update CHANGELOG.md
* Rename functions

* style: pre-commit fixes

* Update CHANGELOG.md

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Using uv for testing and benchmark workflows

* fix failing notebook tests
* Modify update version workflow

* Simplify workflow

* A few more fixes

* Style

* Fix link errors

* Remove manual trigger

* Remove redundant work

* Fix workflow text

* Test workflow

* Change target branch

* Fix

* Remove some test code
…or Windows wheels (pybamm-team#4391)

* Fix CasADi libs workaround for macOS wheels

* Bump to CasADi 3.6.6

* Update vcpkg baseline for CasADi 3.6.6 update

* libc++ is still not fixed

* Fix a typo in the build-system table

* Fix GHA macOS versions for images

* Fix Windows access violation with `msvcp140.dll`

---------

Co-authored-by: Eric G. Kratz <[email protected]>
updates:
- [github.com/astral-sh/ruff-pre-commit: v0.6.2 → v0.6.3](astral-sh/ruff-pre-commit@v0.6.2...v0.6.3)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@kratman
Copy link
Contributor Author

kratman commented Sep 3, 2024

My changes for the release are here:
bac7570 - Updates to the update_version.py script to work with the new versioning.
c212bb0 - Updates to the version strings and change log

Copy link

codecov bot commented Sep 3, 2024

Codecov Report

Attention: Patch coverage is 99.63235% with 1 line in your changes missing coverage. Please review.

Project coverage is 99.42%. Comparing base (7661ed9) to head (c212bb0).
Report is 93 commits behind head on main.

Files with missing lines Patch % Lines
src/pybamm/citations.py 97.22% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4408      +/-   ##
==========================================
- Coverage   99.54%   99.42%   -0.13%     
==========================================
  Files         288      292       +4     
  Lines       21866    22215     +349     
==========================================
+ Hits        21767    22087     +320     
- Misses         99      128      +29     

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

@kratman kratman merged commit 0e50894 into pybamm-team:main Sep 3, 2024
43 of 45 checks passed
@kratman kratman deleted the release/v24.9.0 branch September 3, 2024 19:47
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.