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

OptimiseResult().__str__ across examples, adds OCP balancing script #536

Merged
merged 5 commits into from
Oct 22, 2024

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Oct 21, 2024

Description

  1. Instead of printing the optimisation result values, the OptimiseResult().__str__ is used which includes a better summary inclusive of the optimised values.
  2. Adds a script for fitting the OCP stoichometry parameters for a single particle model from synthetic data.
  3. Sets BaseOptimiser.verbose to default True. This only affects printing the OptimisationResults and the PintBaseOptimiser halt conditions.

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.

@BradyPlanden BradyPlanden added the show This PR will be merged without review label Oct 21, 2024
Copy link

codecov bot commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.09%. Comparing base (c8b00e6) to head (c1e0e62).
Report is 5 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #536      +/-   ##
===========================================
+ Coverage    99.08%   99.09%   +0.01%     
===========================================
  Files           52       54       +2     
  Lines         3605     3764     +159     
===========================================
+ Hits          3572     3730     +158     
- Misses          33       34       +1     

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

@BradyPlanden BradyPlanden merged commit 03877cf into develop Oct 22, 2024
31 checks passed
@BradyPlanden BradyPlanden deleted the ocp-balancing-example branch October 22, 2024 12:47
BradyPlanden added a commit that referenced this pull request Oct 22, 2024
…536)

* adds OCP balancing example, remove redundant code.

* feat: add initial parameters to OptimisationResults

* examples: updates for OptimisationResults __str__

* refactor: OptimisationResult prints with BaseOptimsiser verbose arg, verbose is True as default

* style: pre-commit fixes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
BradyPlanden added a commit that referenced this pull request Nov 25, 2024
…536)

* adds OCP balancing example, remove redundant code.

* feat: add initial parameters to OptimisationResults

* examples: updates for OptimisationResults __str__

* refactor: OptimisationResult prints with BaseOptimsiser verbose arg, verbose is True as default

* style: pre-commit fixes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
show This PR will be merged without review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant