Issue 1810 shortcuts #1822

valentinsulzer · 2021-11-22T23:56:29Z

Description

Fixes #1810 . Should be entirely back-compatible

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

New feature (non-breaking change which adds functionality)
Optimization (back-end change that speeds up the code)
Bug fix (non-breaking change which fixes an issue)

Key checklist:

No style issues: $ flake8
All tests pass: $ python run-tests.py --unit
The documentation builds: $ cd docs and then $ make clean; make html

You can run all three at once, using $ python run-tests.py --quick.

Further checks:

Code is commented, particularly in hard-to-understand areas
Tests added that prove fix is effective or that feature works

codecov · 2021-11-23T00:32:56Z

Codecov Report

Merging #1822 (cc21e58) into develop (6eab5e4) will increase coverage by 0.02%.
The diff coverage is 98.05%.

@@             Coverage Diff             @@
##           develop    #1822      +/-   ##
===========================================
+ Coverage    99.23%   99.25%   +0.02%     
===========================================
  Files          340      340              
  Lines        18790    18773      -17     
===========================================
- Hits         18647    18634      -13     
+ Misses         143      139       -4

Impacted Files	Coverage Δ
pybamm/parameters/parameter_values.py	`98.89% <94.11%> (-0.56%)`	⬇️
...ollector/effective_resistance_current_collector.py	`99.45% <97.82%> (+2.79%)`	⬆️
pybamm/geometry/battery_geometry.py	`100.00% <100.00%> (ø)`
pybamm/meshes/meshes.py	`97.93% <100.00%> (+0.18%)`	⬆️
pybamm/meshes/one_dimensional_submeshes.py	`100.00% <100.00%> (ø)`
pybamm/meshes/scikit_fem_submeshes.py	`100.00% <100.00%> (ø)`
...m/models/full_battery_models/base_battery_model.py	`99.71% <100.00%> (-0.01%)`	⬇️
...l_battery_models/lead_acid/base_lead_acid_model.py	`100.00% <100.00%> (ø)`
...models/full_battery_models/lithium_ion/Yang2017.py	`100.00% <100.00%> (ø)`
...ttery_models/lithium_ion/base_lithium_ion_model.py	`100.00% <100.00%> (ø)`
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6eab5e4...cc21e58. Read the comment docs.

rtimms

thanks @tinosulzer !

rtimms · 2021-11-25T14:49:46Z

examples/scripts/cycling_ageing.py

@@ -11,7 +11,7 @@
    }
 )

-param = pb.ParameterValues(chemistry=pb.parameter_sets.Mohtat2020)
+param = pb.ParameterValues(pb.parameter_sets.Mohtat2020)


can this just be "Mohtat2020"?

rtimms · 2021-11-25T14:50:33Z

examples/scripts/nca_parameters.py

@@ -4,7 +4,7 @@
 model = pb.lithium_ion.DFN()

 chemistry = pb.parameter_sets.NCA_Kim2011
-parameter_values = pb.ParameterValues(chemistry=chemistry)
+parameter_values = pb.ParameterValues(chemistry)


can this just be "Kim2011"?

rtimms · 2021-11-25T14:52:38Z

...gration/test_models/test_full_battery_models/test_lithium_ion/test_basic_half_cell_models.py

@@ -17,7 +17,7 @@ def test_runs_Xu2019(self):

        # load parameter values
        chemistry = pybamm.parameter_sets.Xu2019
-        param = pybamm.ParameterValues(chemistry=chemistry)
+        param = pybamm.ParameterValues(chemistry)


rtimms · 2021-11-25T14:53:06Z

...gration/test_models/test_full_battery_models/test_lithium_ion/test_basic_half_cell_models.py

@@ -48,7 +48,7 @@ def test_runs_Chen2020(self):

        # load parameter values
        chemistry = pybamm.parameter_sets.Chen2020_plating
-        param = pybamm.ParameterValues(chemistry=chemistry)
+        param = pybamm.ParameterValues(chemistry)


"Chen2020_plating"?

rtimms · 2021-11-25T14:53:37Z

tests/integration/test_models/test_full_battery_models/test_lithium_ion/test_thermal_models.py

            chemistry = pybamm.parameter_sets.NCA_Kim2011
-            parameter_values = pybamm.ParameterValues(chemistry=chemistry)
+            parameter_values = pybamm.ParameterValues(chemistry)


rtimms · 2021-11-25T14:55:27Z

tests/unit/test_parameters/test_parameter_sets/test_LFP_Prada2013.py

@@ -27,7 +27,7 @@ def test_load_params(self):
    def test_standard_lithium_parameters(self):

        chemistry = pybamm.parameter_sets.Prada2013
-        parameter_values = pybamm.ParameterValues(chemistry=chemistry)
+        parameter_values = pybamm.ParameterValues(chemistry)


"Prada2013"?

rtimms · 2021-11-25T14:55:38Z

tests/unit/test_parameters/test_parameter_sets/test_LGM50_Chen2020.py

@@ -41,7 +41,7 @@ def test_load_params(self):
    def test_standard_lithium_parameters(self):

        chemistry = pybamm.parameter_sets.Chen2020
-        parameter_values = pybamm.ParameterValues(chemistry=chemistry)
+        parameter_values = pybamm.ParameterValues(chemistry)


"Chen2020"?

rtimms · 2021-11-25T14:55:51Z

tests/unit/test_parameters/test_parameter_sets/test_LGM50_ORegan2021.py

@@ -128,7 +128,7 @@ def test_functions(self):
    def test_standard_lithium_parameters(self):

        chemistry = pybamm.parameter_sets.ORegan2021
-        parameter_values = pybamm.ParameterValues(chemistry=chemistry)
+        parameter_values = pybamm.ParameterValues(chemistry)


"ORegan2021"?

valentinsulzer added 6 commits November 18, 2021 18:45

#1810 allow strings for parameter sets

19c3090

#1810 allow strings in var_pts and geometry

cc1b429

#1810 remove MeshGenerator and fix tests

9434eb9

Merge branch 'develop' into issue-1810-shortcuts

53bf3ad

#1810 fix examples

cc6aea8

Merge branch 'develop' into issue-1810-shortcuts

f64a1f5

valentinsulzer added 3 commits November 24, 2021 14:47

Merge branch 'develop' into issue-1810-shortcuts

8a55d23

#1810 coverage

4f36fa3

#1810 coverage

3fd8fc8

valentinsulzer requested review from rtimms and brosaplanella November 24, 2021 22:24

rtimms approved these changes Nov 25, 2021

View reviewed changes

valentinsulzer added 3 commits November 25, 2021 12:08

Merge branch 'develop' into issue-1810-shortcuts

323aae7

#1810 update tests and examples previously missed

a894c89

#1810 more examples

cc21e58

valentinsulzer merged commit 0ab7c34 into develop Nov 25, 2021

valentinsulzer deleted the issue-1810-shortcuts branch November 25, 2021 19:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue 1810 shortcuts #1822

Issue 1810 shortcuts #1822

valentinsulzer commented Nov 22, 2021

codecov bot commented Nov 23, 2021 •

edited

Loading

rtimms left a comment

rtimms Nov 25, 2021

rtimms Nov 25, 2021

rtimms Nov 25, 2021

rtimms Nov 25, 2021

rtimms Nov 25, 2021

rtimms Nov 25, 2021

rtimms Nov 25, 2021

rtimms Nov 25, 2021

Issue 1810 shortcuts #1822

Issue 1810 shortcuts #1822

Conversation

valentinsulzer commented Nov 22, 2021

Description

Type of change

Key checklist:

Further checks:

codecov bot commented Nov 23, 2021 • edited Loading

Codecov Report

rtimms left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 23, 2021 •

edited

Loading