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

Remove chemistry dep warning #4466

Merged
merged 5 commits into from
Sep 25, 2024
Merged

Remove chemistry dep warning #4466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8cab0f4
Remove chemistry dep warning
kratman Sep 25, 2024
a6f9fa7
Fix changelog
kratman Sep 25, 2024
7ee82a5
style: pre-commit fixes
pre-commit-ci[bot] Sep 25, 2024
a510d1e
Merge branch 'develop' into feat/removeChem
kratman Sep 25, 2024
a979e62
Merge branch 'develop' into feat/removeChem
kratman Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

- Added sensitivity calculation support for `pybamm.Simulation` and `pybamm.Experiment` ([#4415](https://github.com/pybamm-team/PyBaMM/pull/4415))
- Added OpenMP parallelization to IDAKLU solver for lists of input parameters ([#4449](https://github.com/pybamm-team/PyBaMM/pull/4449))
- Added phase-dependent particle options to LAM #4369
- Added phase-dependent particle options to LAM
([#4369](https://github.com/pybamm-team/PyBaMM/pull/4369))
Comment on lines +7 to +8
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Added phase-dependent particle options to LAM
([#4369](https://github.com/pybamm-team/PyBaMM/pull/4369))
- Added phase-dependent particle options to LAM ([#4369](https://github.com/pybamm-team/PyBaMM/pull/4369))

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Both of those render why does this matter?

Copy link
Member

Choose a reason for hiding this comment

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

I think it would split up into a new line on https://pybamm.org/changelog/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is already a bulleted list in that page, if that does not work then there is something wrong with the library used for it

Copy link
Member

Choose a reason for hiding this comment

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

Now that I notice, that page is outdated and does not show any results since 24.1 was last released

Copy link
Member

Choose a reason for hiding this comment

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

In other words, the Goldmark renderer for Hugo has an option to wrap text, will check if it's enabled

arjxn-py marked this conversation as resolved.
Show resolved Hide resolved
- Added a lithium ion equivalent circuit model with split open circuit voltages for each electrode (`SplitOCVR`). ([#4330](https://github.com/pybamm-team/PyBaMM/pull/4330))

## Optimizations
Expand All @@ -18,6 +19,8 @@

## Breaking changes

- Removed the deprecation warning for the chemistry argument in
ParameterValues ([#4466](https://github.com/pybamm-team/PyBaMM/pull/4466))
arjxn-py marked this conversation as resolved.
Show resolved Hide resolved
- The parameters "... electrode OCP entropic change [V.K-1]" and "... electrode volume change" are now expected to be functions of stoichiometry only instead of functions of both stoichiometry and maximum concentration ([#4427](https://github.com/pybamm-team/PyBaMM/pull/4427))
- Renamed `set_events` function to `add_events_from` to better reflect its purpose. ([#4421](https://github.com/pybamm-team/PyBaMM/pull/4421))

Expand Down
10 changes: 1 addition & 9 deletions src/pybamm/parameters/parameter_values.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,7 @@ class ParameterValues:

"""

def __init__(self, values, chemistry=None):
if chemistry is not None:
raise ValueError(
"The 'chemistry' keyword argument has been deprecated. "
"Call `ParameterValues` with a dictionary dictionary of "
"parameter values, or the name of a parameter set (string), "
"as the single argument, e.g. `ParameterValues('Chen2020')`.",
)

def __init__(self, values):
# add physical constants as default values
self._dict_items = pybamm.FuzzyDict(
{
Expand Down
6 changes: 0 additions & 6 deletions tests/unit/test_parameters/test_parameter_values.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,6 @@ def test_init(self):
param = pybamm.ParameterValues({"a": 1, "chemistry": "lithium-ion"})
assert "chemistry" not in param.keys()

# chemistry kwarg removed
with pytest.raises(
ValueError, match="'chemistry' keyword argument has been deprecated"
):
pybamm.ParameterValues(None, chemistry="lithium-ion")

# junk param values rejected
with pytest.raises(ValueError, match="'Junk' is not a valid parameter set."):
pybamm.ParameterValues("Junk")
Expand Down
Loading