PyBaMM-GEM 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pybamm_gem/__init__.py +77 -0
- pybamm_gem/_version.py +24 -0
- pybamm_gem/entry_point.py +154 -0
- pybamm_gem/models/input/ExampleReservoir.py +200 -0
- pybamm_gem/models/input/ExampleSPM.py +215 -0
- pybamm_gem/parameters/input/ExampleChen2020.py +371 -0
- pybamm_gem/parameters/input/Imperial2026.py +352 -0
- pybamm_gem/py.typed +0 -0
- pybamm_gem-0.1.0.dist-info/METADATA +175 -0
- pybamm_gem-0.1.0.dist-info/RECORD +14 -0
- pybamm_gem-0.1.0.dist-info/WHEEL +4 -0
- pybamm_gem-0.1.0.dist-info/entry_points.txt +7 -0
- pybamm_gem-0.1.0.dist-info/licenses/LICENSE +28 -0
- pybamm_gem-0.1.0.dist-info/licenses/LICENSES-bundled.txt +10 -0
|
@@ -0,0 +1,352 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Imperial2026 demonstration parameter set.
|
|
3
|
+
|
|
4
|
+
Status
|
|
5
|
+
------
|
|
6
|
+
Demonstration only.
|
|
7
|
+
|
|
8
|
+
This parameter set is based on the PyBaMM Chen2020 parameter set with minor
|
|
9
|
+
illustrative modifications. It is included to test and demonstrate PyBaMM-GEM
|
|
10
|
+
parameter-set registration. It should not be treated as a validated Imperial
|
|
11
|
+
College cell parameter set.
|
|
12
|
+
|
|
13
|
+
...
|
|
14
|
+
"""
|
|
15
|
+
from __future__ import annotations
|
|
16
|
+
|
|
17
|
+
import numpy as np
|
|
18
|
+
import pybamm
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
def graphite_LGM50_ocp_Chen2020(sto):
|
|
22
|
+
"""
|
|
23
|
+
LG M50 Graphite open-circuit potential as a function of stochiometry, fit taken
|
|
24
|
+
from [1].
|
|
25
|
+
|
|
26
|
+
References
|
|
27
|
+
----------
|
|
28
|
+
.. [1] Chang-Hui Chen, Ferran Brosa Planella, Kieran O’Regan, Dominika Gastol, W.
|
|
29
|
+
Dhammika Widanage, and Emma Kendrick. "Development of Experimental Techniques for
|
|
30
|
+
Parameterization of Multi-scale Lithium-ion Battery Models." Journal of the
|
|
31
|
+
Electrochemical Society 167 (2020): 080534.
|
|
32
|
+
|
|
33
|
+
Parameters
|
|
34
|
+
----------
|
|
35
|
+
sto: :class:`pybamm.Symbol`
|
|
36
|
+
Electrode stochiometry
|
|
37
|
+
|
|
38
|
+
Returns
|
|
39
|
+
-------
|
|
40
|
+
:class:`pybamm.Symbol`
|
|
41
|
+
Open-circuit potential
|
|
42
|
+
"""
|
|
43
|
+
|
|
44
|
+
u_eq = (
|
|
45
|
+
1.9793 * np.exp(-39.3631 * sto)
|
|
46
|
+
+ 0.2482
|
|
47
|
+
- 0.0909 * np.tanh(29.8538 * (sto - 0.1234))
|
|
48
|
+
- 0.04478 * np.tanh(14.9159 * (sto - 0.2769))
|
|
49
|
+
- 0.0205 * np.tanh(30.4444 * (sto - 0.6103))
|
|
50
|
+
)
|
|
51
|
+
|
|
52
|
+
return u_eq
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
def graphite_LGM50_electrolyte_exchange_current_density_Chen2020(
|
|
56
|
+
c_e, c_s_surf, c_s_max, T
|
|
57
|
+
):
|
|
58
|
+
"""
|
|
59
|
+
Exchange-current density for Butler-Volmer reactions between graphite and LiPF6 in
|
|
60
|
+
EC:DMC.
|
|
61
|
+
|
|
62
|
+
References
|
|
63
|
+
----------
|
|
64
|
+
.. [1] Chang-Hui Chen, Ferran Brosa Planella, Kieran O’Regan, Dominika Gastol, W.
|
|
65
|
+
Dhammika Widanage, and Emma Kendrick. "Development of Experimental Techniques for
|
|
66
|
+
Parameterization of Multi-scale Lithium-ion Battery Models." Journal of the
|
|
67
|
+
Electrochemical Society 167 (2020): 080534.
|
|
68
|
+
|
|
69
|
+
Parameters
|
|
70
|
+
----------
|
|
71
|
+
c_e : :class:`pybamm.Symbol`
|
|
72
|
+
Electrolyte concentration [mol.m-3]
|
|
73
|
+
c_s_surf : :class:`pybamm.Symbol`
|
|
74
|
+
Particle concentration [mol.m-3]
|
|
75
|
+
c_s_max : :class:`pybamm.Symbol`
|
|
76
|
+
Maximum particle concentration [mol.m-3]
|
|
77
|
+
T : :class:`pybamm.Symbol`
|
|
78
|
+
Temperature [K]
|
|
79
|
+
|
|
80
|
+
Returns
|
|
81
|
+
-------
|
|
82
|
+
:class:`pybamm.Symbol`
|
|
83
|
+
Exchange-current density [A.m-2]
|
|
84
|
+
"""
|
|
85
|
+
m_ref = 6.48e-7 # (A/m2)(m3/mol)**1.5 - includes ref concentrations
|
|
86
|
+
E_r = 35000
|
|
87
|
+
arrhenius = np.exp(E_r / pybamm.constants.R * (1 / 298.15 - 1 / T))
|
|
88
|
+
|
|
89
|
+
return m_ref * arrhenius * c_e**0.5 * c_s_surf**0.5 * (c_s_max - c_s_surf) ** 0.5
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
def nmc_LGM50_ocp_Chen2020(sto):
|
|
93
|
+
"""
|
|
94
|
+
LG M50 NMC open-circuit potential as a function of stochiometry, fit taken
|
|
95
|
+
from [1].
|
|
96
|
+
|
|
97
|
+
References
|
|
98
|
+
----------
|
|
99
|
+
.. [1] Chang-Hui Chen, Ferran Brosa Planella, Kieran O’Regan, Dominika Gastol, W.
|
|
100
|
+
Dhammika Widanage, and Emma Kendrick. "Development of Experimental Techniques for
|
|
101
|
+
Parameterization of Multi-scale Lithium-ion Battery Models." Journal of the
|
|
102
|
+
Electrochemical Society 167 (2020): 080534.
|
|
103
|
+
|
|
104
|
+
Parameters
|
|
105
|
+
----------
|
|
106
|
+
sto: :class:`pybamm.Symbol`
|
|
107
|
+
Electrode stochiometry
|
|
108
|
+
|
|
109
|
+
Returns
|
|
110
|
+
-------
|
|
111
|
+
:class:`pybamm.Symbol`
|
|
112
|
+
Open-circuit potential
|
|
113
|
+
"""
|
|
114
|
+
|
|
115
|
+
u_eq = (
|
|
116
|
+
-0.8090 * sto
|
|
117
|
+
+ 4.4875
|
|
118
|
+
- 0.0428 * np.tanh(18.5138 * (sto - 0.5542))
|
|
119
|
+
- 17.7326 * np.tanh(15.7890 * (sto - 0.3117))
|
|
120
|
+
+ 17.5842 * np.tanh(15.9308 * (sto - 0.3120))
|
|
121
|
+
)
|
|
122
|
+
|
|
123
|
+
return u_eq
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
def nmc_LGM50_electrolyte_exchange_current_density_Chen2020(c_e, c_s_surf, c_s_max, T):
|
|
127
|
+
"""
|
|
128
|
+
Exchange-current density for Butler-Volmer reactions between NMC and LiPF6 in
|
|
129
|
+
EC:DMC.
|
|
130
|
+
|
|
131
|
+
References
|
|
132
|
+
----------
|
|
133
|
+
.. [1] Chang-Hui Chen, Ferran Brosa Planella, Kieran O’Regan, Dominika Gastol, W.
|
|
134
|
+
Dhammika Widanage, and Emma Kendrick. "Development of Experimental Techniques for
|
|
135
|
+
Parameterization of Multi-scale Lithium-ion Battery Models." Journal of the
|
|
136
|
+
Electrochemical Society 167 (2020): 080534.
|
|
137
|
+
|
|
138
|
+
Parameters
|
|
139
|
+
----------
|
|
140
|
+
c_e : :class:`pybamm.Symbol`
|
|
141
|
+
Electrolyte concentration [mol.m-3]
|
|
142
|
+
c_s_surf : :class:`pybamm.Symbol`
|
|
143
|
+
Particle concentration [mol.m-3]
|
|
144
|
+
c_s_max : :class:`pybamm.Symbol`
|
|
145
|
+
Maximum particle concentration [mol.m-3]
|
|
146
|
+
T : :class:`pybamm.Symbol`
|
|
147
|
+
Temperature [K]
|
|
148
|
+
|
|
149
|
+
Returns
|
|
150
|
+
-------
|
|
151
|
+
:class:`pybamm.Symbol`
|
|
152
|
+
Exchange-current density [A.m-2]
|
|
153
|
+
"""
|
|
154
|
+
m_ref = 3.42e-6 # (A/m2)(m3/mol)**1.5 - includes ref concentrations
|
|
155
|
+
E_r = 17800
|
|
156
|
+
arrhenius = np.exp(E_r / pybamm.constants.R * (1 / 298.15 - 1 / T))
|
|
157
|
+
|
|
158
|
+
return m_ref * arrhenius * c_e**0.5 * c_s_surf**0.5 * (c_s_max - c_s_surf) ** 0.5
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
def electrolyte_diffusivity_Nyman2008(c_e, T):
|
|
162
|
+
"""
|
|
163
|
+
Diffusivity of LiPF6 in EC:EMC (3:7) as a function of ion concentration. The data
|
|
164
|
+
comes from [1]
|
|
165
|
+
|
|
166
|
+
References
|
|
167
|
+
----------
|
|
168
|
+
.. [1] A. Nyman, M. Behm, and G. Lindbergh, "Electrochemical characterisation and
|
|
169
|
+
modelling of the mass transport phenomena in LiPF6-EC-EMC electrolyte,"
|
|
170
|
+
Electrochim. Acta, vol. 53, no. 22, pp. 6356–6365, 2008.
|
|
171
|
+
|
|
172
|
+
Parameters
|
|
173
|
+
----------
|
|
174
|
+
c_e: :class:`pybamm.Symbol`
|
|
175
|
+
Dimensional electrolyte concentration
|
|
176
|
+
T: :class:`pybamm.Symbol`
|
|
177
|
+
Dimensional temperature
|
|
178
|
+
|
|
179
|
+
Returns
|
|
180
|
+
-------
|
|
181
|
+
:class:`pybamm.Symbol`
|
|
182
|
+
Solid diffusivity
|
|
183
|
+
"""
|
|
184
|
+
|
|
185
|
+
D_c_e = 8.794e-11 * (c_e / 1000) ** 2 - 3.972e-10 * (c_e / 1000) + 4.862e-10
|
|
186
|
+
|
|
187
|
+
# Nyman et al. (2008) does not provide temperature dependence
|
|
188
|
+
|
|
189
|
+
return D_c_e
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
def electrolyte_conductivity_Nyman2008(c_e, T):
|
|
193
|
+
"""
|
|
194
|
+
Conductivity of LiPF6 in EC:EMC (3:7) as a function of ion concentration. The data
|
|
195
|
+
comes from [1].
|
|
196
|
+
|
|
197
|
+
References
|
|
198
|
+
----------
|
|
199
|
+
.. [1] A. Nyman, M. Behm, and G. Lindbergh, "Electrochemical characterisation and
|
|
200
|
+
modelling of the mass transport phenomena in LiPF6-EC-EMC electrolyte,"
|
|
201
|
+
Electrochim. Acta, vol. 53, no. 22, pp. 6356–6365, 2008.
|
|
202
|
+
|
|
203
|
+
Parameters
|
|
204
|
+
----------
|
|
205
|
+
c_e: :class:`pybamm.Symbol`
|
|
206
|
+
Dimensional electrolyte concentration
|
|
207
|
+
T: :class:`pybamm.Symbol`
|
|
208
|
+
Dimensional temperature
|
|
209
|
+
|
|
210
|
+
Returns
|
|
211
|
+
-------
|
|
212
|
+
:class:`pybamm.Symbol`
|
|
213
|
+
Solid diffusivity
|
|
214
|
+
"""
|
|
215
|
+
|
|
216
|
+
sigma_e = (
|
|
217
|
+
0.1297 * (c_e / 1000) ** 3 - 2.51 * (c_e / 1000) ** 1.5 + 3.329 * (c_e / 1000)
|
|
218
|
+
)
|
|
219
|
+
|
|
220
|
+
# Nyman et al. (2008) does not provide temperature dependence
|
|
221
|
+
|
|
222
|
+
return sigma_e
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
# Call dict via a function to avoid errors when editing in place
|
|
226
|
+
def get_parameter_values():
|
|
227
|
+
"""
|
|
228
|
+
Parameters for an LG M50 cell, from the paper :footcite:t:`Chen2020` and references
|
|
229
|
+
therein.
|
|
230
|
+
|
|
231
|
+
SEI parameters are example parameters for SEI growth from the papers
|
|
232
|
+
:footcite:t:`Ramadass2004`, :footcite:t:`ploehn2004solvent`,
|
|
233
|
+
:footcite:t:`single2018identifying`, :footcite:t:`safari2008multimodal`, and
|
|
234
|
+
:footcite:t:`Yang2017`
|
|
235
|
+
|
|
236
|
+
.. note::
|
|
237
|
+
This parameter set does not claim to be representative of the true parameter
|
|
238
|
+
values. Instead these are parameter values that were used to fit SEI models to
|
|
239
|
+
observed experimental data in the referenced papers.
|
|
240
|
+
"""
|
|
241
|
+
|
|
242
|
+
return {
|
|
243
|
+
"chemistry": "lithium_ion",
|
|
244
|
+
# sei
|
|
245
|
+
"Ratio of lithium moles to SEI moles": 2.0,
|
|
246
|
+
"Inner SEI reaction proportion": 0.5,
|
|
247
|
+
"Inner SEI partial molar volume [m3.mol-1]": 9.585e-05,
|
|
248
|
+
"Outer SEI partial molar volume [m3.mol-1]": 9.585e-05,
|
|
249
|
+
"SEI reaction exchange current density [A.m-2]": 1.5e-07,
|
|
250
|
+
"SEI resistivity [Ohm.m]": 200000.0,
|
|
251
|
+
"Outer SEI solvent diffusivity [m2.s-1]": 2.5000000000000002e-22,
|
|
252
|
+
"Bulk solvent concentration [mol.m-3]": 2636.0,
|
|
253
|
+
"Inner SEI open-circuit potential [V]": 0.1,
|
|
254
|
+
"Outer SEI open-circuit potential [V]": 0.8,
|
|
255
|
+
"Inner SEI electron conductivity [S.m-1]": 8.95e-14,
|
|
256
|
+
"Inner SEI lithium interstitial diffusivity [m2.s-1]": 1e-20,
|
|
257
|
+
"Lithium interstitial reference concentration [mol.m-3]": 15.0,
|
|
258
|
+
"Initial inner SEI thickness [m]": 2.5e-09,
|
|
259
|
+
"Initial outer SEI thickness [m]": 2.5e-09,
|
|
260
|
+
"EC initial concentration in electrolyte [mol.m-3]": 4541.0,
|
|
261
|
+
"EC diffusivity [m2.s-1]": 2e-18,
|
|
262
|
+
"SEI kinetic rate constant [m.s-1]": 1e-12,
|
|
263
|
+
"SEI open-circuit potential [V]": 0.4,
|
|
264
|
+
"SEI growth activation energy [J.mol-1]": 0.0,
|
|
265
|
+
"Negative electrode reaction-driven LAM factor [m3.mol-1]": 0.0,
|
|
266
|
+
"Positive electrode reaction-driven LAM factor [m3.mol-1]": 0.0,
|
|
267
|
+
# cell
|
|
268
|
+
"Negative current collector thickness [m]": 1.2e-05,
|
|
269
|
+
"Negative electrode thickness [m]": 8.52e-05,
|
|
270
|
+
"Separator thickness [m]": 1.2e-05,
|
|
271
|
+
"Positive electrode thickness [m]": 7.56e-05,
|
|
272
|
+
"Positive current collector thickness [m]": 1.6e-05,
|
|
273
|
+
"Electrode height [m]": 0.065,
|
|
274
|
+
"Electrode width [m]": 1.58,
|
|
275
|
+
"Cell cooling surface area [m2]": 0.00531,
|
|
276
|
+
"Cell volume [m3]": 2.42e-05,
|
|
277
|
+
"Cell thermal expansion coefficient [m.K-1]": 1.1e-06,
|
|
278
|
+
"Negative current collector conductivity [S.m-1]": 58411000.0,
|
|
279
|
+
"Positive current collector conductivity [S.m-1]": 36914000.0,
|
|
280
|
+
"Negative current collector density [kg.m-3]": 8960.0,
|
|
281
|
+
"Positive current collector density [kg.m-3]": 2700.0,
|
|
282
|
+
"Negative current collector specific heat capacity [J.kg-1.K-1]": 385.0,
|
|
283
|
+
"Positive current collector specific heat capacity [J.kg-1.K-1]": 897.0,
|
|
284
|
+
"Negative current collector thermal conductivity [W.m-1.K-1]": 401.0,
|
|
285
|
+
"Positive current collector thermal conductivity [W.m-1.K-1]": 237.0,
|
|
286
|
+
"Nominal cell capacity [A.h]": 5.0,
|
|
287
|
+
"Current function [A]": 5.0,
|
|
288
|
+
"Contact resistance [Ohm]": 0,
|
|
289
|
+
# negative electrode
|
|
290
|
+
"Negative electrode conductivity [S.m-1]": 215.0,
|
|
291
|
+
"Maximum concentration in negative electrode [mol.m-3]": 33133.0,
|
|
292
|
+
"Negative particle diffusivity [m2.s-1]": 3.3e-14,
|
|
293
|
+
"Negative electrode OCP [V]": graphite_LGM50_ocp_Chen2020,
|
|
294
|
+
"Negative electrode porosity": 0.25,
|
|
295
|
+
"Negative electrode active material volume fraction": 0.75,
|
|
296
|
+
"Negative particle radius [m]": 5.86e-06,
|
|
297
|
+
"Negative electrode Bruggeman coefficient (electrolyte)": 1.5,
|
|
298
|
+
"Negative electrode Bruggeman coefficient (electrode)": 0,
|
|
299
|
+
"Negative electrode charge transfer coefficient": 0.5,
|
|
300
|
+
"Negative electrode double-layer capacity [F.m-2]": 0.2,
|
|
301
|
+
"Negative electrode exchange-current density [A.m-2]"
|
|
302
|
+
"": graphite_LGM50_electrolyte_exchange_current_density_Chen2020,
|
|
303
|
+
"Negative electrode density [kg.m-3]": 1657.0,
|
|
304
|
+
"Negative electrode specific heat capacity [J.kg-1.K-1]": 700.0,
|
|
305
|
+
"Negative electrode thermal conductivity [W.m-1.K-1]": 1.7,
|
|
306
|
+
"Negative electrode OCP entropic change [V.K-1]": 0.0,
|
|
307
|
+
# positive electrode
|
|
308
|
+
"Positive electrode conductivity [S.m-1]": 0.18,
|
|
309
|
+
"Maximum concentration in positive electrode [mol.m-3]": 63104.0,
|
|
310
|
+
"Positive particle diffusivity [m2.s-1]": 4e-15,
|
|
311
|
+
"Positive electrode OCP [V]": nmc_LGM50_ocp_Chen2020,
|
|
312
|
+
"Positive electrode porosity": 0.335,
|
|
313
|
+
"Positive electrode active material volume fraction": 0.665,
|
|
314
|
+
"Positive particle radius [m]": 5.22e-06,
|
|
315
|
+
"Positive electrode Bruggeman coefficient (electrolyte)": 1.5,
|
|
316
|
+
"Positive electrode Bruggeman coefficient (electrode)": 0,
|
|
317
|
+
"Positive electrode charge transfer coefficient": 0.5,
|
|
318
|
+
"Positive electrode double-layer capacity [F.m-2]": 0.2,
|
|
319
|
+
"Positive electrode exchange-current density [A.m-2]"
|
|
320
|
+
"": nmc_LGM50_electrolyte_exchange_current_density_Chen2020,
|
|
321
|
+
"Positive electrode density [kg.m-3]": 3262.0,
|
|
322
|
+
"Positive electrode specific heat capacity [J.kg-1.K-1]": 700.0,
|
|
323
|
+
"Positive electrode thermal conductivity [W.m-1.K-1]": 2.1,
|
|
324
|
+
"Positive electrode OCP entropic change [V.K-1]": 0.0,
|
|
325
|
+
# separator
|
|
326
|
+
"Separator porosity": 0.47,
|
|
327
|
+
"Separator Bruggeman coefficient (electrolyte)": 1.5,
|
|
328
|
+
"Separator density [kg.m-3]": 397.0,
|
|
329
|
+
"Separator specific heat capacity [J.kg-1.K-1]": 700.0,
|
|
330
|
+
"Separator thermal conductivity [W.m-1.K-1]": 0.16,
|
|
331
|
+
# electrolyte
|
|
332
|
+
"Initial concentration in electrolyte [mol.m-3]": 1000.0,
|
|
333
|
+
"Cation transference number": 0.2594,
|
|
334
|
+
"Thermodynamic factor": 1.0,
|
|
335
|
+
"Electrolyte diffusivity [m2.s-1]": electrolyte_diffusivity_Nyman2008,
|
|
336
|
+
"Electrolyte conductivity [S.m-1]": electrolyte_conductivity_Nyman2008,
|
|
337
|
+
# experiment
|
|
338
|
+
"Reference temperature [K]": 298.15,
|
|
339
|
+
"Total heat transfer coefficient [W.m-2.K-1]": 10.0,
|
|
340
|
+
"Ambient temperature [K]": 298.15,
|
|
341
|
+
"Number of electrodes connected in parallel to make a cell": 1.0,
|
|
342
|
+
"Number of cells connected in series to make a battery": 1.0,
|
|
343
|
+
"Lower voltage cut-off [V]": 2.5,
|
|
344
|
+
"Upper voltage cut-off [V]": 4.2,
|
|
345
|
+
"Open-circuit voltage at 0% SOC [V]": 2.5,
|
|
346
|
+
"Open-circuit voltage at 100% SOC [V]": 4.2,
|
|
347
|
+
"Initial concentration in negative electrode [mol.m-3]": 29866.0,
|
|
348
|
+
"Initial concentration in positive electrode [mol.m-3]": 17038.0,
|
|
349
|
+
"Initial temperature [K]": 298.15,
|
|
350
|
+
# citations
|
|
351
|
+
"notcite": ["Chen2020"],
|
|
352
|
+
}
|
pybamm_gem/py.typed
ADDED
|
File without changes
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: PyBaMM-GEM
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A PyBaMM-compatible extension package for advanced battery models, research models, and simulation tools.
|
|
5
|
+
Project-URL: Homepage, https://github.com/mohammedasher/PyBaMM-GEM
|
|
6
|
+
Project-URL: Bug Tracker, https://github.com/mohammedasher/PyBaMM-GEM/issues
|
|
7
|
+
Project-URL: Discussions, https://github.com/mohammedasher/PyBaMM-GEM/discussions
|
|
8
|
+
Project-URL: Changelog, https://github.com/mohammedasher/PyBaMM-GEM/releases
|
|
9
|
+
Author-email: Mohammed Asheruddin N <mnazeeru@ic.ac.uk>
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
License-File: LICENSES-bundled.txt
|
|
12
|
+
Classifier: Development Status :: 1 - Planning
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Intended Audience :: Science/Research
|
|
15
|
+
Classifier: License :: OSI Approved :: BSD License
|
|
16
|
+
Classifier: Operating System :: OS Independent
|
|
17
|
+
Classifier: Programming Language :: Python
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
25
|
+
Classifier: Topic :: Scientific/Engineering
|
|
26
|
+
Classifier: Typing :: Typed
|
|
27
|
+
Requires-Python: <3.15,>=3.10
|
|
28
|
+
Requires-Dist: pybamm
|
|
29
|
+
Provides-Extra: dev
|
|
30
|
+
Requires-Dist: nox[uv]; extra == 'dev'
|
|
31
|
+
Requires-Dist: pre-commit; extra == 'dev'
|
|
32
|
+
Requires-Dist: pytest-cov>=3; extra == 'dev'
|
|
33
|
+
Requires-Dist: pytest>=6; extra == 'dev'
|
|
34
|
+
Provides-Extra: docs
|
|
35
|
+
Requires-Dist: ipython; extra == 'docs'
|
|
36
|
+
Requires-Dist: myst-parser; extra == 'docs'
|
|
37
|
+
Requires-Dist: nbsphinx; extra == 'docs'
|
|
38
|
+
Requires-Dist: pydata-sphinx-theme; extra == 'docs'
|
|
39
|
+
Requires-Dist: sphinx; extra == 'docs'
|
|
40
|
+
Requires-Dist: sphinx-autobuild; extra == 'docs'
|
|
41
|
+
Requires-Dist: sphinx-copybutton; extra == 'docs'
|
|
42
|
+
Requires-Dist: sphinx-design; extra == 'docs'
|
|
43
|
+
Requires-Dist: sphinx-gallery; extra == 'docs'
|
|
44
|
+
Requires-Dist: sphinx-inline-tabs; extra == 'docs'
|
|
45
|
+
Requires-Dist: sphinx-last-updated-by-git; extra == 'docs'
|
|
46
|
+
Requires-Dist: sphinxcontrib-bibtex; extra == 'docs'
|
|
47
|
+
Description-Content-Type: text/markdown
|
|
48
|
+
|
|
49
|
+
# PyBaMM-GEM
|
|
50
|
+
|
|
51
|
+
PyBaMM-GEM is an open, collaborative ecosystem for developing, validating, sharing, and maintaining advanced battery models, submodels, and parameter sets that extend the PyBaMM framework.
|
|
52
|
+
|
|
53
|
+
PyBaMM has transformed battery modelling by providing a powerful, modular, and open-source framework for electrochemical simulation. As battery research continues to advance, new models are constantly being developed to address emerging scientific questions, explore new physical phenomena, and support industrial innovation. Many of these developments are experimental, highly specialised, or under active research, making them unsuitable for inclusion in the core PyBaMM project during their early stages.
|
|
54
|
+
|
|
55
|
+
**PyBaMM-GEM provides a home for these developments.**
|
|
56
|
+
|
|
57
|
+
Rather than maintaining a separate modelling framework or encouraging fragmented forks of PyBaMM, GEM extends the PyBaMM ecosystem by providing a common platform where researchers can develop, compare, validate, publish, and maintain cutting-edge battery models while remaining closely aligned with the design philosophy and user experience of PyBaMM.
|
|
58
|
+
|
|
59
|
+
Some GEM models may eventually become part of the core PyBaMM project. Others may remain within GEM because they address specialised scientific questions or niche applications. Both outcomes are considered successful.
|
|
60
|
+
|
|
61
|
+
Our long-term vision is to establish PyBaMM-GEM as a collaborative ecosystem where the next generation of battery models is developed, evaluated, and shared with the wider community.
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
# Why GEM?
|
|
66
|
+
|
|
67
|
+
Scientific software advances by balancing two complementary objectives: stability and innovation.
|
|
68
|
+
|
|
69
|
+
PyBaMM rightly prioritises stability, maintainability, and broad community applicability.
|
|
70
|
+
|
|
71
|
+
Research, however, moves much faster.
|
|
72
|
+
|
|
73
|
+
Every year, researchers develop new electrochemical models, degradation mechanisms, parameterisations, constitutive laws, numerical approaches, and modelling assumptions. These developments often require years of validation before they are mature enough for inclusion in a widely used scientific software package. Some may never belong in the core library because they address specialised scientific or industrial problems.
|
|
74
|
+
|
|
75
|
+
PyBaMM-GEM provides an environment where these ideas can be developed openly while remaining fully compatible with PyBaMM.
|
|
76
|
+
|
|
77
|
+
The goal is not to replace PyBaMM.
|
|
78
|
+
|
|
79
|
+
The goal is to accelerate battery modelling research around PyBaMM.
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
# What belongs in GEM?
|
|
84
|
+
|
|
85
|
+
PyBaMM-GEM focuses exclusively on extending the modelling capabilities of PyBaMM.
|
|
86
|
+
|
|
87
|
+
The project includes:
|
|
88
|
+
|
|
89
|
+
* Battery models
|
|
90
|
+
* Battery submodels
|
|
91
|
+
* Parameter sets
|
|
92
|
+
* Modified variants of existing PyBaMM models and submodels
|
|
93
|
+
* Documentation, scripts, and notebooks accompanying each contribution
|
|
94
|
+
|
|
95
|
+
Every scientific contribution should include runnable examples demonstrating:
|
|
96
|
+
|
|
97
|
+
* the scientific motivation,
|
|
98
|
+
* implementation,
|
|
99
|
+
* validation (where available),
|
|
100
|
+
* and how it differs from the corresponding implementation in PyBaMM.
|
|
101
|
+
|
|
102
|
+
PyBaMM-GEM is **not** intended to become a general battery software platform. Workflow management, optimisation, digital twins, data analysis, and unrelated utilities are intentionally outside the scope of this project.
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
# Design Philosophy
|
|
107
|
+
|
|
108
|
+
The philosophy of GEM is simple.
|
|
109
|
+
|
|
110
|
+
**Stay close to PyBaMM. Explore beyond it.**
|
|
111
|
+
|
|
112
|
+
GEM follows the architecture, programming style, and user experience of PyBaMM wherever practical. Existing PyBaMM users should feel immediately familiar with GEM, allowing new scientific developments to be adopted with minimal learning.
|
|
113
|
+
|
|
114
|
+
Scientific transparency is a fundamental principle. GEM never silently changes the behaviour of an existing PyBaMM implementation. Whenever a GEM implementation differs scientifically from PyBaMM, it is exposed through an explicit GEM-specific model or option so that published research remains reproducible and unambiguous.
|
|
115
|
+
|
|
116
|
+
Every release of GEM is developed against a defined range of PyBaMM versions and documents its compatibility.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
# Why "GEM"?
|
|
121
|
+
|
|
122
|
+
Originally, **GEM** stood for **General Enough Model**—a long-standing research vision of developing battery models with the minimum complexity required to explain the physical behaviour of interest.
|
|
123
|
+
|
|
124
|
+
As the project evolved, this philosophy naturally broadened. GEM also represents the idea of a **Good Enough Model**: selecting the minimum set of physical processes and governing equations required to accurately describe a given scientific problem without unnecessary complexity.
|
|
125
|
+
|
|
126
|
+
The name is also inspired by **Professor John B. Goodenough**, whose pioneering contributions fundamentally shaped modern lithium-ion battery science and continue to inspire battery modelling research today.
|
|
127
|
+
|
|
128
|
+
While these meanings reflect the origins and philosophy of the project, **GEM has grown beyond an acronym**. Today, PyBaMM-GEM represents an ecosystem dedicated to advancing battery modelling research through open, collaborative scientific software.
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
# Installation
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
pip install pybamm-gem
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
```python
|
|
139
|
+
import pybamm_gem
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
# Relationship with PyBaMM
|
|
145
|
+
|
|
146
|
+
PyBaMM-GEM depends on the official PyBaMM project.
|
|
147
|
+
|
|
148
|
+
It does not replace PyBaMM, fork PyBaMM, or maintain an independent battery modelling framework.
|
|
149
|
+
|
|
150
|
+
Instead, GEM extends the PyBaMM ecosystem.
|
|
151
|
+
|
|
152
|
+
Where appropriate, mature GEM models may eventually be adopted into PyBaMM. Conversely, specialised research models may continue to be developed and maintained within GEM indefinitely.
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
# Contributing
|
|
157
|
+
|
|
158
|
+
Researchers from academia, industry, and national laboratories are encouraged to contribute new models, submodels, parameter sets, documentation, validation studies, and example notebooks.
|
|
159
|
+
|
|
160
|
+
Every contribution should improve the scientific capability of the PyBaMM ecosystem while preserving the principles of transparency, reproducibility, and compatibility that underpin both PyBaMM and GEM.
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
# Citation
|
|
165
|
+
|
|
166
|
+
If you use PyBaMM-GEM in academic work, please cite both:
|
|
167
|
+
|
|
168
|
+
* PyBaMM
|
|
169
|
+
* the relevant GEM model or publication
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
# License
|
|
174
|
+
|
|
175
|
+
PyBaMM-GEM is distributed under the BSD 3-Clause License.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
pybamm_gem/__init__.py,sha256=IKKdKFndFtpcKmvvPN-TabHX8yM6hVK8mNfROLkCEac,1971
|
|
2
|
+
pybamm_gem/_version.py,sha256=ptILGutmCA6QX4OPt03bkYZX2VUTr2ovOOy8vb2k2ZU,544
|
|
3
|
+
pybamm_gem/entry_point.py,sha256=seyHUdkCuVEnQMcSSYfFW9VaAUuWO4sfBm3JGQwIN3w,5883
|
|
4
|
+
pybamm_gem/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
5
|
+
pybamm_gem/models/input/ExampleReservoir.py,sha256=cnVaDITgvzG4XMcWHrnji-2IVKEchOVEuJElpENmycs,8143
|
|
6
|
+
pybamm_gem/models/input/ExampleSPM.py,sha256=MWv4qN5_blE7SgXrvbzJMZMHNRhl0ZGxUSy2tO9Zm78,9199
|
|
7
|
+
pybamm_gem/parameters/input/ExampleChen2020.py,sha256=kLdBpJJSzWZsWLIao-DOndWl5lXrfQM-Zc3oT9XZwo0,14458
|
|
8
|
+
pybamm_gem/parameters/input/Imperial2026.py,sha256=XWfT06pyQJ6aVchGw9CUiPZDA4tdBlRXvUnBoQmU4QA,13230
|
|
9
|
+
pybamm_gem-0.1.0.dist-info/METADATA,sha256=GjS2ueMaKcyc1cZBCGN5V41aXv8H-ihOS_891Rdi1FE,8230
|
|
10
|
+
pybamm_gem-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
|
|
11
|
+
pybamm_gem-0.1.0.dist-info/entry_points.txt,sha256=V8Xo4PQZlqURk66Fgu-yP7rdsQwqX0BjF_drhWiGRxc,314
|
|
12
|
+
pybamm_gem-0.1.0.dist-info/licenses/LICENSE,sha256=1Oum00Onojua1dvoXyb4u84g-Jg4zlygVmkm8PBsU3A,1542
|
|
13
|
+
pybamm_gem-0.1.0.dist-info/licenses/LICENSES-bundled.txt,sha256=xjAH_dzMvL8GprtST6bECw4eKnzm0pNHPIUn-ewhEMU,321
|
|
14
|
+
pybamm_gem-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
[models]
|
|
2
|
+
ExampleReservoir = pybamm_gem.models.input.ExampleReservoir:BasicReservoir
|
|
3
|
+
ExampleSPM = pybamm_gem.models.input.ExampleSPM:SPM
|
|
4
|
+
|
|
5
|
+
[parameter_sets]
|
|
6
|
+
ExampleChen2020 = pybamm_gem.parameters.input.ExampleChen2020:get_parameter_values
|
|
7
|
+
Imperial2026 = pybamm_gem.parameters.input.Imperial2026:get_parameter_values
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
BSD 3-Clause License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026, Mohammed Asheruddin (Asher)
|
|
4
|
+
|
|
5
|
+
Redistribution and use in source and binary forms, with or without
|
|
6
|
+
modification, are permitted provided that the following conditions are met:
|
|
7
|
+
|
|
8
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
9
|
+
list of conditions and the following disclaimer.
|
|
10
|
+
|
|
11
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
12
|
+
this list of conditions and the following disclaimer in the documentation
|
|
13
|
+
and/or other materials provided with the distribution.
|
|
14
|
+
|
|
15
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
16
|
+
contributors may be used to endorse or promote products derived from
|
|
17
|
+
this software without specific prior written permission.
|
|
18
|
+
|
|
19
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
20
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
21
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
22
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
23
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
24
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
25
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
26
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
27
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
28
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
This project and source distributions bundle several libraries that are
|
|
2
|
+
compatibly licensed.
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
Name: PyBaMM
|
|
6
|
+
Files: - src/pybamm_gem/parameters/input/Chen2020.py
|
|
7
|
+
- src/pybamm_gem/models/input/BasicReservoir.py
|
|
8
|
+
- src/pybamm_gem/models/input/SPM.py
|
|
9
|
+
- src/pybamm_gem/entry_point.py
|
|
10
|
+
License: BSD-3-Clause
|