Skip to content

Align ParameterSet with pybamm.ParameterValues#593

Merged
NicolaCourtier merged 21 commits into
developfrom
parameter-sets
Jan 24, 2025
Merged

Align ParameterSet with pybamm.ParameterValues#593
NicolaCourtier merged 21 commits into
developfrom
parameter-sets

Conversation

@NicolaCourtier

@NicolaCourtier NicolaCourtier commented Dec 12, 2024

Copy link
Copy Markdown
Member

Description

A step towards aligning our ParameterSet class with pybamm.ParameterValues and clarifying which formats can be used to create a model parameter set. In this iteration, the ParameterSet class stores the parameter dictionary or pybamm.ParameterValues object and returns a copied pybamm.ParameterValues object when called.

Issue reference

Show feature

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.

@codecov

codecov Bot commented Dec 12, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.23%. Comparing base (9df5000) to head (68f9ddc).
Report is 66 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #593   +/-   ##
========================================
  Coverage    99.22%   99.23%           
========================================
  Files           62       62           
  Lines         4536     4549   +13     
========================================
+ Hits          4501     4514   +13     
  Misses          35       35           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@NicolaCourtier NicolaCourtier marked this pull request as ready for review December 12, 2024 15:46

@BradyPlanden BradyPlanden left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @NicolaCourtier - this looks like a nice improvement. As we've updated to BPX > 0.5 in develop, I think it would be a good idea to update this branch to confirm these changes don't have clashes with the new version.

Comment thread pybop/parameters/parameter_set.py Outdated
Comment thread pybop/parameters/parameter_set.py Outdated
Comment thread pybop/parameters/parameter_set.py Outdated
@NicolaCourtier NicolaCourtier merged commit 29b33df into develop Jan 24, 2025
@NicolaCourtier NicolaCourtier deleted the parameter-sets branch January 24, 2025 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants