Merge pull request #2739 from pybamm-team/develop

Make release v23.2

Author: brosaplanella

.all-contributorsrc

@@ -128,7 +128,7 @@
       "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/",
+      "profile": "https://github.com/dalonsoa",
       "contributions": [
         "bug",
         "review",
@@ -549,9 +549,47 @@
       "name": "iatzak",
       "avatar_url": "https://avatars.githubusercontent.com/u/112731474?v=4",
       "profile": "https://github.com/iatzak",
+      "contributions": [
+        "doc",
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "ayeankit",
+      "name": "Ankit Kumar",
+      "avatar_url": "https://avatars.githubusercontent.com/u/72691866?v=4",
+      "profile": "https://github.com/ayeankit",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "dikwickley",
+      "name": "Aniket Singh Rawat",
+      "avatar_url": "https://avatars.githubusercontent.com/u/31622972?v=4",
+      "profile": "https://aniketsinghrawat.vercel.app/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "jeromtom",
+      "name": "Jerom Palimattom Tom",
+      "avatar_url": "https://avatars.githubusercontent.com/u/83979298?v=4",
+      "profile": "https://github.com/jeromtom",
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "BradyPlanden",
+      "name": "Brady Planden",
+      "avatar_url": "https://avatars.githubusercontent.com/u/55357039?v=4",
+      "profile": "http://bradyplanden.github.io",
+      "contributions": [
+        "example"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/ISSUE_TEMPLATE/new_parameter_set.yml

@@ -6,7 +6,7 @@ body:
       value: |
         Third-party parameter sets can be added to PyBaMM by registering an entry
         point with `pybamm-parameter-sets` as described in our
-        [documentation](https://pybamm.readthedocs.io/en/latest/source/parameters/parameter_sets.html).
+        [documentation](https://pybamm.readthedocs.io/en/latest/source/api/parameters/parameter_sets.html).
   - type: input
     id: parameter-set-url
     attributes:

.github/PULL_REQUEST_TEMPLATE.md

@@ -14,11 +14,11 @@ Please add a line in the relevant section of [CHANGELOG.md](https://github.com/p
 
 # Key checklist:
 
-- [ ] No style issues: `$ pre-commit run`
-- [ ] All tests pass: `$ python run-tests.py --unit`
-- [ ] The documentation builds: `$ cd docs` and then `$ make clean; make html`
+- [ ] No style issues: `$ pre-commit run` (see [CONTRIBUTING.md](https://github.com/pybamm-team/PyBaMM/blob/develop/CONTRIBUTING.md#installing-and-using-pre-commit) for how to set this up to run automatically when committing locally, in just two lines of code)
+- [ ] All tests pass: `$ python run-tests.py --all`
+- [ ] The documentation builds: `$ python run-tests.py --doctest`
 
-You can run all three at once, using `$ python run-tests.py --quick`.
+You can run unit and doctests together at once, using `$ python run-tests.py --quick`.
 
 ## Further checks:
 

.github/workflows/url_checker.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
       - name: URLs-checker
-        uses: urlstechie/urlchecker-action@0.0.31
+        uses: urlstechie/urlchecker-action@master
         with:
           # A comma-separated list of file types to cover in the URL checks
           file_types: .rst,.md,.py,.ipynb

.gitignore

@@ -6,6 +6,7 @@
 *.DS_Store
 *.mat
 *.csv
+*.hidden
 
 # don't ignore important .txt and .csv files
 !requirements*

.pre-commit-config.yaml

@@ -3,19 +3,13 @@ ci:
   autofix_commit_msg: "style: pre-commit fixes"
 
 repos:
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.0-alpha.4
-    hooks:
-      - id: prettier
-        exclude: assets/js/webapp\.js
-
   - repo: https://github.com/psf/black
-    rev: 22.12.0
+    rev: 23.1.0
     hooks:
       - id: black
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.0.237"
+    rev: "v0.0.253"
     hooks:
       - id: ruff
         args: [--ignore=E741, --exclude=__init__.py]

CHANGELOG.md

@@ -1,5 +1,18 @@
 # [Unreleased](https://github.com/pybamm-team/PyBaMM/)
 
+# [v23.2](https://github.com/pybamm-team/PyBaMM/tree/v23.2) - 2023-02-28
+
+## Features
+
+- Added an option for using a banded jacobian and sundials banded solvers for the IDAKLU solve [#2677](https://github.com/pybamm-team/PyBaMM/pull/2677)
+- The "particle size" option can now be a tuple to allow different behaviour in each electrode([#2672](https://github.com/pybamm-team/PyBaMM/pull/2672)).
+- Added temperature control to experiment class. [#2518](https://github.com/pybamm-team/PyBaMM/pull/2518)
+
+## Bug fixes
+
+- Fixed current_sigmoid_ocp to be valid for both electrodes ([#2719](https://github.com/pybamm-team/PyBaMM/pull/2719)).
+- Fixed the length scaling for the first dimension of r-R plots ([#2663](https://github.com/pybamm-team/PyBaMM/pull/2663)).
+
 # [v23.1](https://github.com/pybamm-team/PyBaMM/tree/v23.1) - 2023-01-31
 
 ## Features

CITATION.cff

@@ -24,6 +24,6 @@ keywords:
   - "expression tree"
   - "python"
   - "symbolic differentiation"
-version: "23.1"
+version: "23.2"
 repository-code: "https://github.com/pybamm-team/PyBaMM"
 title: "Python Battery Mathematical Modelling (PyBaMM)"

CONTRIBUTING.md

@@ -37,7 +37,7 @@ We use [GIT](https://en.wikipedia.org/wiki/Git) and [GitHub](https://en.wikipedi
 1. Create an [issue](https://guides.github.com/features/issues/) where new proposals can be discussed before any coding is done.
 2. Create a [branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) of this repo (ideally on your own [fork](https://help.github.com/articles/fork-a-repo/)), where all changes will be made
 3. Download the source code onto your local system, by [cloning](https://help.github.com/articles/cloning-a-repository/) the repository (or your fork of the repository).
-4. [Install](https://pybamm.readthedocs.io/en/latest/install/install-from-source.html) PyBaMM with the developer options.
+4. [Install](https://pybamm.readthedocs.io/en/latest/source/user_guide/installation/install-from-source.html) PyBaMM with the developer options.
 5. [Test](#testing) if your installation worked, using the test script: `$ python run-tests.py --unit`.
 
 You now have everything you need to start making changes!
@@ -61,7 +61,7 @@ Finally, if you really, really, _really_ love developing PyBaMM, have a look at
 
 ## Coding style guidelines
 
-PyBaMM follows the [PEP8 recommendations](https://www.python.org/dev/peps/pep-0008/) for coding style. These are very common guidelines, and community tools have been developed to check how well projects implement them. We recommend using pre-commit hooks to check your code before committing it. See [installing and using pre-commit](https://github.com/pybamm-team/PyBaMM/blob/develop/CONTRIBUTING.md#installing-and-using-pre-commit) section for more details.
+PyBaMM follows the [PEP8 recommendations](https://www.python.org/dev/peps/pep-0008/) for coding style. These are very common guidelines, and community tools have been developed to check how well projects implement them. We recommend using pre-commit hooks to check your code before committing it. See [installing and using pre-commit](#installing-and-using-pre-commit) section for more details.
 
 ### Ruff
 
@@ -307,7 +307,7 @@ PyBaMM is documented in several ways.
 
 First and foremost, every method and every class should have a [docstring](https://www.python.org/dev/peps/pep-0257/) that describes in plain terms what it does, and what the expected input and output is.
 
-These docstrings can be fairly simple, but can also make use of [reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html), a markup language designed specifically for writing [technical documentation](https://en.wikipedia.org/wiki/ReStructuredText). For example, you can link to other classes and methods by writing ``:class:`pybamm.Model` `` and ``:meth:`run()` ``.
+These docstrings can be fairly simple, but can also make use of [reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html), a markup language designed specifically for writing [technical documentation](https://en.wikipedia.org/wiki/ReStructuredText). For example, you can link to other classes and methods by writing `` :class:`pybamm.Model`  `` and `` :meth:`run()`  ``.
 
 In addition, we write a (very) small bit of documentation in separate reStructuredText files in the `docs` directory. Most of what these files do is simply import docstrings from the source code. But they also do things like add tables and indexes. If you've added a new class to a module, search the `docs` directory for that module's `.rst` file and add your class (in alphabetical order) to its index. If you've added a whole new module, copy-paste another module's file and add a link to your new file in the appropriate `index.rst` file.