Skip to content

Commit e82ca77

Browse files
priyanshuone6priyanshuone6
authored
Merge branch 'develop' into setattr
2 parents 3273909 + fe6960c commit e82ca77

File tree

130 files changed

+5488
-4466
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

130 files changed

+5488
-4466
lines changed

‎CHANGELOG.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,21 @@
33
## Features
44

55
- Added Base Parameters class and SymPy in dependencies ([#1495](https://github.com/pybamm-team/PyBaMM/pull/1495))
6+
- Added a new "reaction-driven" model for LAM from Reniers et al (2019) ([#1490](https://github.com/pybamm-team/PyBaMM/pull/1490))
7+
- Some features ("loss of active material" and "particle mechanics") can now be specified separately for the negative electrode and positive electrode by passing a 2-tuple ([#1490](https://github.com/pybamm-team/PyBaMM/pull/1490))
68
- `plot` and `plot2D` now take and return a matplotlib Axis to allow for easier customization ([#1472](https://github.com/pybamm-team/PyBaMM/pull/1472))
79
- `ParameterValues.evaluate` can now return arrays to allow function parameters to be easily evaluated ([#1472](https://github.com/pybamm-team/PyBaMM/pull/1472))
10+
- Added option to save only specific cycle numbers when simulating an `Experiment` ([#1459](https://github.com/pybamm-team/PyBaMM/pull/1459))
11+
- Added capacity-based termination conditions when simulating an `Experiment` ([#1459](https://github.com/pybamm-team/PyBaMM/pull/1459))
12+
- Added "summary variables" to track degradation over several cycles ([#1459](https://github.com/pybamm-team/PyBaMM/pull/1459))
13+
- Added `ElectrodeSOH` model for calculating capacities and stoichiometric limits ([#1459](https://github.com/pybamm-team/PyBaMM/pull/1459))
814
- Added Batch Study class ([#1455](https://github.com/pybamm-team/PyBaMM/pull/1455))
915
- Added `ConcatenationVariable`, which is automatically created when variables are concatenated ([#1453](https://github.com/pybamm-team/PyBaMM/pull/1453))
1016
- Added "fast with events" mode for the CasADi solver, which solves a model and finds events more efficiently than "safe" mode. As of PR #1450 this feature is still being tested and "safe" mode remains the default ([#1450](https://github.com/pybamm-team/PyBaMM/pull/1450))
1117

1218
## Optimizations
1319

20+
- Models that mostly use x-averaged quantities (SPM and SPMe) now use x-averaged degradation models ([#1490](https://github.com/pybamm-team/PyBaMM/pull/1490))
1421
- Improved how the CasADi solver's "safe" mode finds events ([#1450](https://github.com/pybamm-team/PyBaMM/pull/1450))
1522
- Perform more automatic simplifications of the expression tree ([#1449](https://github.com/pybamm-team/PyBaMM/pull/1449))
1623
- Reduce time taken to hash a sparse `Matrix` object ([#1449](https://github.com/pybamm-team/PyBaMM/pull/1449))
@@ -21,6 +28,7 @@
2128

2229
## Breaking changes
2330

31+
- Changed how options are specified for the "loss of active material" and "particle cracking" submodels. "loss of active material" can now be one of "none", "stress-driven", or "reaction-driven", or a 2-tuple for different options in negative and positive electrode. Similarly "particle cracking" (now called "particle mechanics") can now be "none", "swelling only", "swelling and cracking", or a 2-tuple ([#1490](https://github.com/pybamm-team/PyBaMM/pull/1490))
2432
- Changed the variable in the full diffusion model from "Electrolyte concentration" to "Porosity times concentration" ([#1476](https://github.com/pybamm-team/PyBaMM/pull/1476))
2533
- Renamed `lithium-ion` folder to `lithium_ion` and `lead-acid` folder to `lead_acid` in parameters ([#1464](https://github.com/pybamm-team/PyBaMM/pull/1464))
2634

@@ -95,11 +103,11 @@ This release introduces:
95103

96104
# [v0.3.0](https://github.com/pybamm-team/PyBaMM/tree/v0.3.0) - 2020-12-01
97105

98-
This release introduces a new aging model for particle swelling and cracking, a new reduced-order model (TSPMe), and a parameter set for A123 LFP cells. Additionally, there have been several backend optimizations to speed up model creation and solving, and other minor features and bug fixes.
106+
This release introduces a new aging model for particle mechanics, a new reduced-order model (TSPMe), and a parameter set for A123 LFP cells. Additionally, there have been several backend optimizations to speed up model creation and solving, and other minor features and bug fixes.
99107

100108
## Features
101109

102-
- Added a submodel for particle swelling and cracking ([#1232](https://github.com/pybamm-team/PyBaMM/pull/1232))
110+
- Added a submodel for particle mechanics ([#1232](https://github.com/pybamm-team/PyBaMM/pull/1232))
103111
- Added a notebook on how to speed up the solver and handle instabilities ([#1223](https://github.com/pybamm-team/PyBaMM/pull/1223))
104112
- Improve string printing of `BinaryOperator`, `Function`, and `Concatenation` objects ([#1223](https://github.com/pybamm-team/PyBaMM/pull/1223))
105113
- Added `Solution.integration_time`, which is the time taken just by the integration subroutine, without extra setups ([#1223](https://github.com/pybamm-team/PyBaMM/pull/1223))

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ We use [black](https://black.readthedocs.io/en/stable/) to automatically configu
126126
black {source_file_or_directory}
127127
```
128128

129-
2. Editor: black can be [configured](https://black.readthedocs.io/en/stable/editor_integration.html) to automatically reformat a python script each time the script is saved in an editor.
129+
2. Editor: black can be [configured](https://test-black.readthedocs.io/en/latest/editor_integration.html) to automatically reformat a python script each time the script is saved in an editor.
130130

131131
If you want to use black in your editor, you may need to change the max line length in your editor settings.
132132

‎docs/source/models/base_models/base_battery_model.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ Base Battery Model
44
.. autoclass:: pybamm.BaseBatteryModel
55
:members:
66

7-
.. autoclass:: pybamm.Options
7+
.. autoclass:: pybamm.BatteryModelOptions
88
:members:

‎docs/source/models/submodels/active_material/base_active_material.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Base Model
2+
===========
3+
4+
.. autoclass:: pybamm.active_material.BaseModel
5+
:members:
6+

‎docs/source/models/submodels/active_material/constant_active_material.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Constant Active Material
2+
========================
3+
4+
.. autoclass:: pybamm.active_material.Constant
5+
:members:
6+
7+

‎docs/source/models/submodels/active_material/index.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Active Material
2+
===============
3+
4+
Submodels for (loss of) active material
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
base_active_material
10+
constant_active_material
11+
reaction_driven_active_material
12+
stress_driven_active_material
13+

‎docs/source/models/submodels/active_material/reaction_driven_active_material.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Reaction-driven Loss of Active Material
2+
=======================================
3+
4+
.. autoclass:: pybamm.active_material.ReactionDriven
5+
:members:
6+
7+
8+

‎docs/source/models/submodels/active_material/stress_driven_active_material.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Stress-driven Loss of Active Material
2+
=====================================
3+
4+
.. autoclass:: pybamm.active_material.StressDriven
5+
:members:
6+
7+
8+

‎docs/source/models/submodels/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Submodels
55
:maxdepth: 1
66

77
base_submodel
8+
active_material/index
89
current_collector/index
910
convection/index
1011
electrode/index

‎docs/source/models/submodels/particle_cracking/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ Particle Cracking
66

77
base_cracking
88
crack_propagation
9-
no_cracking
9+
swelling_only

‎docs/source/models/submodels/particle_cracking/no_cracking.rst

-5
This file was deleted.

‎docs/source/models/submodels/particle_cracking/swelling_only.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Swelling Only Model
2+
===================
3+
4+
.. autoclass:: pybamm.particle_cracking.SwellingOnly
5+
:members:

‎docs/source/models/submodels/porosity/full_reaction_driven_porosity.rst

-7
This file was deleted.

‎docs/source/models/submodels/porosity/index.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,5 @@ Porosity
66

77
base_porosity
88
constant_porosity
9-
leading_reaction_driven_porosity
10-
full_reaction_driven_porosity
9+
reaction_driven_porosity
1110

‎docs/source/models/submodels/porosity/leading_reaction_driven_porosity.rst

-8
This file was deleted.

‎docs/source/models/submodels/porosity/reaction_driven_porosity.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Reaction-driven Model
2+
=====================
3+
4+
.. autoclass:: pybamm.porosity.ReactionDriven
5+
:members:
6+
7+
8+

‎examples/notebooks/Getting Started/Tutorial 3 - Basic plotting.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -455,9 +455,9 @@
455455
" 'Current collector current density',\n",
456456
" 'Current collector current density [A.m-2]',\n",
457457
" 'Leading-order current collector current density',\n",
458-
" 'Sei interfacial current density',\n",
459-
" 'Sei interfacial current density [A.m-2]',\n",
460-
" 'Sei interfacial current density per volume [A.m-3]',\n",
458+
" 'SEI interfacial current density',\n",
459+
" 'SEI interfacial current density [A.m-2]',\n",
460+
" 'SEI interfacial current density per volume [A.m-3]',\n",
461461
" 'Negative electrode interfacial current density',\n",
462462
" 'X-averaged negative electrode interfacial current density',\n",
463463
" 'Negative electrode interfacial current density [A.m-2]',\n",

‎examples/notebooks/Getting Started/Tutorial 5 - Run experiments.ipynb

+14-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,20 @@
227227
"name": "python",
228228
"nbconvert_exporter": "python",
229229
"pygments_lexer": "ipython3",
230-
"version": "3.7.4"
230+
"version": "3.8.8"
231+
},
232+
"toc": {
233+
"base_numbering": 1,
234+
"nav_menu": {},
235+
"number_sections": true,
236+
"sideBar": true,
237+
"skip_h1_title": false,
238+
"title_cell": "Table of Contents",
239+
"title_sidebar": "Contents",
240+
"toc_cell": false,
241+
"toc_position": {},
242+
"toc_section_display": true,
243+
"toc_window_display": true
231244
}
232245
},
233246
"nbformat": 4,

‎examples/notebooks/Validating_mechanical_models_Enertech_DFN.ipynb

-337
This file was deleted.

0 commit comments

Comments
 (0)