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.

Sign up for GitHub

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

Jump to bottom

Added InputParameter support in PyBamm experiments #4826

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Added InputParameter support in PyBamm experiments #4826

wants to merge 3 commits into from
+77 −11

Conversation

Rishab87
Copy link

@Rishab87 Rishab87 commented Feb 7, 2025

Description

Added InputParameter support in experiments, now you can pass them something like this:

current_step = pybamm.step.current(1, input_parameters=pybamm.InputParameter("I_app"), termination="2.5 V")
experiment = pybamm.Experiment(
    input_parameters={"I_app": 1},
    termination="2.5 V",
    operating_conditions=[current_step],
)

Fixes #4799

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

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

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 tests pass: $ python -m pytest (or $ nox -s tests)
  • The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

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

Further checks:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brosaplanella brosaplanella Awaiting requested review from brosaplanella brosaplanella is a code owner

@martinjrobins martinjrobins Awaiting requested review from martinjrobins martinjrobins is a code owner

@rtimms rtimms Awaiting requested review from rtimms rtimms is a code owner

@valentinsulzer valentinsulzer Awaiting requested review from valentinsulzer valentinsulzer is a code owner

@TomTranter TomTranter Awaiting requested review from TomTranter TomTranter is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use InputParameter in pybamm experiment
2 participants
@Rishab87 @brosaplanella