Merge pull request #856 from pybamm-team/issue-820-release

Issue 820 release

.requirements-docs.txt

@@ -1,11 +1,10 @@
 # Requirements for readthedocs.io
 numpy>=1.14
-scipy>=1.0
+scipy>=1.3
 pandas>=0.23
 anytree>=2.4.3
 autograd>=1.2
 scikit-fem>=0.2.0
 casadi>=3.5.0
 guzzle-sphinx-theme
 sphinx>=1.5
-python-Levenshtein>=0.12.0

CHANGELOG.md

@@ -1,4 +1,6 @@
-# [Unreleased](https://github.com/pybamm-team/PyBaMM)
+# [v0.2.0](https://github.com/pybamm-team/PyBaMM/tree/v0.2.0) - 2020-02-26
+
+This release introduces many new features and optimizations. All models can now be solved using the pip installation - in particular, the DFN can be solved in around 0.1s. Other highlights include an improved user interface, simulations of experimental protocols (GITT, CCCV, etc), new parameter sets for NCA and LGM50, drive cycles, "input parameters" and "external variables" for quickly solving models with different parameter values and coupling with external software, and general bug fixes and optimizations.
 
 ## Features
 

README.md

@@ -7,7 +7,7 @@
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pybamm-team/PyBaMM/master?filepath=examples%2Fnotebooks)
 [![black_code_style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
-Python Battery Mathematical Modelling solves continuum models for batteries, using both numerical methods and asymptotic analysis.
+PyBaMM (Python Battery Mathematical Modelling) solves physics-based electrochemical DAE models by using state-of-the-art automatic differentiation and numerical solvers. The Doyle-Fuller-Newman model can be solved in under 0.1 seconds, while the reduced-order Single Particle Model and Single Particle Model with electrolyte can be solved in just a few milliseconds. Additional physics can easily be included such as thermal effects, fast particle diffusion, 3D effects, and more. All models are implemented in a flexible manner, and a wide range of models and parameter sets (NCA, NMC, LiCoO2, ...) are available. There is also functionality to simulate any set of experimental instructions, such as CCCV or GITT, or specify drive cycles.
 
 ## How do I use PyBaMM?
 
@@ -19,6 +19,24 @@ sim = pybamm.Simulation(model)
 sim.solve()
 sim.plot()
 ```
+or simulate an experiment such as CCCV:
+```python3
+import pybamm
+experiment = pybamm.Experiment(
+    [
+        "Discharge at C/10 for 10 hours or until 3.3 V",
+        "Rest for 1 hour",
+        "Charge at 1 A until 4.1 V",
+        "Hold at 4.1 V until 50 mA",
+        "Rest for 1 hour",
+    ]
+    * 3,
+)
+model = pybamm.lithium_ion.DFN()
+sim = pybamm.Simulation(model, experiment=experiment, solver=pybamm.CasadiSolver())
+sim.solve()
+sim.plot()
+```
 However, much greater customisation is available. It is possible to change the physics, parameter values, geometry, submesh type,  number of submesh points, methods for spatial discretisation and solver for integration (see DFN [script](examples/scripts/DFN.py) or [notebook](examples/notebooks/models/dfn.ipynb)).
 
 For new users we recommend the [Getting Started](examples/notebooks/Getting%20Started/) guides. These are intended to be very simple step-by-step guides to show the basic functionality of PyBaMM.
@@ -50,7 +68,7 @@ instructions please see [here](INSTALL-WINDOWS.md)
 
 If you use PyBaMM in your work, please cite our paper
 
-"Sulzer, V., Marquis, S. G., Timms, R., Robinson, M., & Chapman, S. J. (2020). Python Battery Mathematical Modelling (PyBaMM). _ECSarXiv. February, 7_."
+> Sulzer, V., Marquis, S. G., Timms, R., Robinson, M., & Chapman, S. J. (2020). Python Battery Mathematical Modelling (PyBaMM). _ECSarXiv. February, 7_.
 
 You can use the bibtex
 

docs/conf.py

@@ -22,13 +22,13 @@
 # -- Project information -----------------------------------------------------
 
 project = "PyBaMM"
-copyright = "2018, Valentin Sulzer"
-author = "Valentin Sulzer"
+copyright = "2020, Valentin Sulzer"
+author = "The PyBaMM Team"
 
 # The short X.Y version
-version = ""
+version = "0.2"
 # The full version, including alpha/beta/rc tags
-release = ""
+release = "0.2.0"
 
 
 # -- General configuration ---------------------------------------------------

examples/scripts/experimental_protocols/cccv.py

@@ -7,16 +7,15 @@
 pybamm.set_logging_level("INFO")
 experiment = pybamm.Experiment(
     [
-        "Discharge at C/10 for 13 hours or until 3.3 V",
+        "Discharge at C/10 for 10 hours or until 3.3 V",
         "Rest for 1 hour",
         "Charge at 1 A until 4.1 V",
         "Hold at 4.1 V until 50 mA",
         "Rest for 1 hour",
     ]
     * 3,
-    period="2 minutes",
 )
-model = pybamm.lithium_ion.DFN()  # use {"thermal": "x-lumped"} for thermal effects
+model = pybamm.lithium_ion.DFN()
 sim = pybamm.Simulation(model, experiment=experiment, solver=pybamm.CasadiSolver())
 sim.solve()
 

pybamm/CITATIONS.txt

@@ -123,3 +123,15 @@ journal={ECSarXiv. February},
 volume={7},
 year={2020}
 }
+
+@software{scikit-fem,
+  author       = {Tom Gustafsson and
+                  Geordie McBain},
+  title        = {kinnala/scikit-fem 0.4.0},
+  month        = jan,
+  year         = 2020,
+  publisher    = {Zenodo},
+  version      = {0.4.0},
+  doi          = {10.5281/zenodo.3597656},
+  url          = {https://doi.org/10.5281/zenodo.3597656}
+}

pybamm/spatial_methods/scikit_finite_element.py

@@ -29,6 +29,7 @@ class ScikitFiniteElement(pybamm.SpatialMethod):
 
     def __init__(self, options=None):
         super().__init__(options)
+        pybamm.citations.register("scikit-fem")
 
     def build(self, mesh):
         super().build(mesh)

pybamm/version

@@ -1 +1 @@
-0, 1, 0
+0, 2, 0

tests/unit/test_citations.py

@@ -74,6 +74,14 @@ def test_sulzer_2019(self):
         pybamm.lead_acid.Full(build=False)
         self.assertIn("sulzer2019physical", citations._papers_to_cite)
 
+    def test_scikit_fem(self):
+        citations = pybamm.citations
+
+        citations._reset()
+        self.assertNotIn("scikit-fem", citations._papers_to_cite)
+        pybamm.ScikitFiniteElement()
+        self.assertIn("scikit-fem", citations._papers_to_cite)
+
     def test_parameter_citations(self):
         citations = pybamm.citations