Merge pull request #1256 from pybamm-team/release-0.3.0

Release 0.3.0 - master

.all-contributorsrc

@@ -0,0 +1,283 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "contributors": [
+    {
+      "login": "tinosulzer",
+      "name": "Valentin Sulzer",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/20817509?v=4",
+      "profile": "https://sites.google.com/view/valentinsulzer",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "example",
+        "ideas",
+        "maintenance",
+        "review",
+        "test",
+        "tutorial",
+        "blog"
+      ]
+    },
+    {
+      "login": "rtimms",
+      "name": "Robert Timms",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/43040151?v=4",
+      "profile": "http://www.robertwtimms.com",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "example",
+        "ideas",
+        "maintenance",
+        "review",
+        "test",
+        "tutorial"
+      ]
+    },
+    {
+      "login": "Scottmar93",
+      "name": "Scott Marquis",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/22661308?v=4",
+      "profile": "https://github.com/Scottmar93",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "example",
+        "ideas",
+        "maintenance",
+        "review",
+        "test",
+        "tutorial"
+      ]
+    },
+    {
+      "login": "martinjrobins",
+      "name": "Martin Robinson",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/1148404?v=4",
+      "profile": "https://github.com/martinjrobins",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "example",
+        "ideas",
+        "review",
+        "test"
+      ]
+    },
+    {
+      "login": "ferranbrosa",
+      "name": "Ferran Brosa Planella",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/28443643?v=4",
+      "profile": "https://www.brosaplanella.com",
+      "contributions": [
+        "review",
+        "bug",
+        "code",
+        "doc",
+        "example",
+        "ideas",
+        "maintenance",
+        "test",
+        "tutorial",
+        "blog"
+      ]
+    },
+    {
+      "login": "TomTranter",
+      "name": "Tom Tranter",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/7068741?v=4",
+      "profile": "https://github.com/TomTranter",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "example",
+        "ideas",
+        "review",
+        "test"
+      ]
+    },
+    {
+      "login": "tlestang",
+      "name": "Thibault Lestang",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/13448239?v=4",
+      "profile": "http://tlestang.github.io",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "example",
+        "ideas",
+        "review",
+        "test",
+        "infra"
+      ]
+    },
+    {
+      "login": "dalonsoa",
+      "name": "Diego",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/6095790?v=4",
+      "profile": "https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/research-software-engineering/",
+      "contributions": [
+        "bug",
+        "review",
+        "code",
+        "infra"
+      ]
+    },
+    {
+      "login": "felipe-salinas",
+      "name": "felipe-salinas",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/64426781?v=4",
+      "profile": "https://github.com/felipe-salinas",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "suhaklee",
+      "name": "suhaklee",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/57151989?v=4",
+      "profile": "https://github.com/suhaklee",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "viviantran27",
+      "name": "viviantran27",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/6379429?v=4",
+      "profile": "https://github.com/viviantran27",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "gyouhoc",
+      "name": "gyouhoc",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/60714526?v=4",
+      "profile": "https://github.com/gyouhoc",
+      "contributions": [
+        "bug",
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "YannickNoelStephanKuhn",
+      "name": "Yannick Kuhn",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/62429912?v=4",
+      "profile": "https://github.com/YannickNoelStephanKuhn",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "jedgedrudd",
+      "name": "Jacqueline Edge",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/39409226?v=4",
+      "profile": "http://batterymodel.co.uk",
+      "contributions": [
+        "ideas",
+        "eventOrganizing",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "fcooper8472",
+      "name": "Fergus Cooper",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/3770306?v=4",
+      "profile": "https://www.rse.ox.ac.uk/",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "jonchapman1",
+      "name": "jonchapman1",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/28925818?v=4",
+      "profile": "https://github.com/jonchapman1",
+      "contributions": [
+        "ideas",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "colinplease",
+      "name": "Colin Please",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/44977104?v=4",
+      "profile": "https://github.com/colinplease",
+      "contributions": [
+        "ideas",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "FaradayInstitution",
+      "name": "Faraday Institution",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/42166506?v=4",
+      "profile": "https://faraday.ac.uk",
+      "contributions": [
+        "financial"
+      ]
+    },
+    {
+      "login": "bessman",
+      "name": "Alexander Bessman",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/1999462?v=4",
+      "profile": "https://github.com/bessman",
+      "contributions": [
+        "bug",
+        "example"
+      ]
+    },
+    {
+      "login": "dalbamont",
+      "name": "dalbamont",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/19659095?v=4",
+      "profile": "https://github.com/dalbamont",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "anandmy",
+      "name": "Anand Mohan Yadav",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/34894671?v=4",
+      "profile": "https://github.com/anandmy",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "weilongai",
+      "name": "WEILONG AI",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/41424174?v=4",
+      "profile": "https://github.com/weilongai",
+      "contributions": [
+        "code",
+        "example",
+        "test"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "projectName": "PyBaMM",
+  "projectOwner": "pybamm-team",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "skipCi": true
+}

.github/release_checklist.md

@@ -1,4 +1,4 @@
-- Increment version number in `version`
-- Increment version number in `docs/conf.py`
-- Update CHANGELOG.md with a summary of the release
-- Update (and pin) jax and jaxlib to latest version and fix any bugs that arise
+- Increment version number in `version`	
+- Increment version number in `docs/conf.py`	
+- Update CHANGELOG.md with a summary of the release	
+- Update (and pin) jax and jaxlib to latest version and fix any bugs that arise	

.github/workflows/build_wheels_and_publish.yml

@@ -37,10 +37,6 @@ jobs:
     - name: Install build-time deps for MacOS
       if: matrix.os == 'macos-latest'
       run: |
-        # Temporary fix for https://github.com/actions/virtual-environments/issues/1811
-        brew untap local/homebrew-openssl
-        brew untap local/homebrew-python2
-        # End of fix
         brew update
         brew install graphviz
         brew install sundials

.github/workflows/test_on_push.yml

@@ -50,10 +50,6 @@ jobs:
     - name: Install MacOS system dependencies
       if: matrix.os == 'macos-latest'
       run: |
-        # Temporary fix for https://github.com/actions/virtual-environments/issues/1811
-        brew untap local/homebrew-openssl
-        brew untap local/homebrew-python2
-        # End of fix
         brew update
         brew install graphviz
         brew install openblas
@@ -87,8 +83,8 @@ jobs:
       if: matrix.os != 'windows-latest'
       run: tox -e examples
 
-    - name: Instal and run coverage
-      if: success() && (matrix.os == 'unbuntu-latest' && matrix.python-version == 3.7)
+    - name: Install and run coverage
+      if: success() && (matrix.os == 'ubuntu-latest' && matrix.python-version == 3.7)
       run: tox -e coverage
 
     - name: Upload coverage report

CHANGELOG.md

@@ -1,3 +1,41 @@
+# [v0.3.0](https://github.com/pybamm-team/PyBaMM)
+
+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.
+
+## Features
+
+-   Added a submodel for particle swelling and cracking ([#1232](https://github.com/pybamm-team/PyBaMM/pull/1232))
+-   Added a notebook on how to speed up the solver and handle instabilities ([#1223](https://github.com/pybamm-team/PyBaMM/pull/1223))
+-   Improve string printing of `BinaryOperator`, `Function`, and `Concatenation` objects ([#1223](https://github.com/pybamm-team/PyBaMM/pull/1223))
+-   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))
+-   Added parameter set for an A123 LFP cell ([#1209](https://github.com/pybamm-team/PyBaMM/pull/1209))
+-   Added variables related to equivalent circuit models ([#1204](https://github.com/pybamm-team/PyBaMM/pull/1204))
+-   Added the `Integrated` electrolyte conductivity submodel ([#1188](https://github.com/pybamm-team/PyBaMM/pull/1188))
+-   Added an example script to check conservation of lithium ([#1186](https://github.com/pybamm-team/PyBaMM/pull/1186))
+-   Added `erf` and `erfc` functions ([#1184](https://github.com/pybamm-team/PyBaMM/pull/1184))
+
+## Optimizations
+
+-   Add (optional) smooth approximations for the `Minimum`, `Maximum`, `Heaviside`, and `AbsoluteValue` operators ([#1223](https://github.com/pybamm-team/PyBaMM/pull/1223))
+-   Avoid unnecessary repeated computations in the solvers ([#1222](https://github.com/pybamm-team/PyBaMM/pull/1222))
+-   Rewrite `Symbol.is_constant` to be more efficient ([#1222](https://github.com/pybamm-team/PyBaMM/pull/1222))
+-   Cache shape and size calculations ([#1222](https://github.com/pybamm-team/PyBaMM/pull/1222))
+-   Only instantiate the geometric, electrical and thermal parameter classes once ([#1222](https://github.com/pybamm-team/PyBaMM/pull/1222))
+
+## Bug fixes
+
+-   Quickplot now works when timescale or lengthscale is a function of an input parameter ([#1234](https://github.com/pybamm-team/PyBaMM/pull/1234))
+-   Fix bug that was slowing down creation of the EC reaction SEI submodel ([#1227](https://github.com/pybamm-team/PyBaMM/pull/1227))
+-   Add missing separator thermal parameters for the Ecker parameter set ([#1226](https://github.com/pybamm-team/PyBaMM/pull/1226))
+-   Make sure simulation solves when evaluated timescale is a function of an input parameter ([#1218](https://github.com/pybamm-team/PyBaMM/pull/1218))
+-   Raise error if saving to MATLAB with variable names that MATLAB can't read, and give option of providing alternative variable names ([#1206](https://github.com/pybamm-team/PyBaMM/pull/1206))
+-   Raise error if the boundary condition at the origin in a spherical domain is other than no-flux ([#1175](https://github.com/pybamm-team/PyBaMM/pull/1175))
+-   Fix boundary conditions at r = 0 for Creating Models notebooks ([#1173](https://github.com/pybamm-team/PyBaMM/pull/1173))
+
+## Breaking changes
+
+-    The parameters "Positive/Negative particle distribution in x" and "Positive/Negative surface area per unit volume distribution in x" have been deprecated. Instead, users can provide "Positive/Negative particle radius [m]" and "Positive/Negative surface area per unit volume [m-1]" directly as functions of through-cell position (x [m]) ([#1237](https://github.com/pybamm-team/PyBaMM/pull/1237)) 
+
 # [v0.2.4](https://github.com/pybamm-team/PyBaMM/tree/v0.2.4) - 2020-09-07
 
 This release adds new operators for more complex models, some basic sensitivity analysis, and a spectral volumes spatial method, as well as some small bug fixes.

MANIFEST.in

@@ -28,6 +28,8 @@ include pybamm/input/parameters/lithium-ion/electrolytes/lipf6_Nyman2008/paramet
 include pybamm/input/parameters/lithium-ion/separators/separator_Kim2011/parameters.csv
 include pybamm/input/parameters/lithium-ion/separators/separator_Chen2020/parameters.csv
 include pybamm/input/parameters/lithium-ion/separators/separator_Marquis2019/parameters.csv
+include pybamm/input/parameters/lithium-ion/mechanicals/lico2_graphite_Ai2020/parameters.csv
+include pybamm/input/parameters/lithium-ion/anodes/graphite_Ai2020/graphite_ocp_Enertech_Ai2020.csv
 include pybamm/input/parameters/lead-acid/anodes/lead_Sulzer2019/lead_ocp_Bode1977.py
 include pybamm/input/parameters/lead-acid/cathodes/lead_dioxide_Sulzer2019/lead_dioxide_ocp_Bode1977.py
 include pybamm/input/parameters/lead-acid/electrolytes/sulfuric_acid_Sulzer2019/diffusivity_Gu1997.py
@@ -82,6 +84,7 @@ include pybamm/input/parameters/lithium-ion/electrolytes/lipf6_Nyman2008/README.
 include pybamm/input/parameters/lithium-ion/separators/separator_Kim2011/README.md
 include pybamm/input/parameters/lithium-ion/separators/separator_Chen2020/README.md
 include pybamm/input/parameters/lithium-ion/separators/separator_Marquis2019/README.md
+include pybamm/input/parameters/lithium-ion/mechanicals/lico2_graphite_Ai2020/README.md
 include pybamm/version
 include pybamm/CITATIONS.txt
 include CMakeBuild.py