Skip to content

Commit d1f466f

Browse files
#820 revert scikit fem version and add citation
1 parent d9d7581 commit d1f466f

File tree

5 files changed

+24
-2
lines changed

5 files changed

+24
-2
lines changed

.requirements-docs.txt

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# Requirements for readthedocs.io
22
numpy>=1.14
3-
scipy>=1.0
3+
scipy>=1.3
44
pandas>=0.23
55
anytree>=2.4.3
66
autograd>=1.2
77
scikit-fem>=0.2.0
88
casadi>=3.5.0
99
guzzle-sphinx-theme
1010
sphinx>=1.5
11-
python-Levenshtein>=0.12.0

pybamm/CITATIONS.txt

+12
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,15 @@ journal={ECSarXiv. February},
123123
volume={7},
124124
year={2020}
125125
}
126+
127+
@software{scikit-fem,
128+
author = {Tom Gustafsson and
129+
Geordie McBain},
130+
title = {kinnala/scikit-fem 0.4.0},
131+
month = jan,
132+
year = 2020,
133+
publisher = {Zenodo},
134+
version = {0.4.0},
135+
doi = {10.5281/zenodo.3597656},
136+
url = {https://doi.org/10.5281/zenodo.3597656}
137+
}

pybamm/spatial_methods/scikit_finite_element.py

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ class ScikitFiniteElement(pybamm.SpatialMethod):
2929

3030
def __init__(self, options=None):
3131
super().__init__(options)
32+
pybamm.citations.register("scikit-fem")
3233

3334
def build(self, mesh):
3435
super().build(mesh)

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

+2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ def test_basic_processing_1plus1D(self):
3434
modeltest.test_all(skip_output_tests=True)
3535

3636
def test_basic_processing_2plus1D(self):
37+
pybamm.set_logging_level("DEBUG")
3738
options = {"current collector": "potential pair", "dimensionality": 2}
3839
model = pybamm.lithium_ion.DFN(options)
3940
var = pybamm.standard_spatial_vars
@@ -48,6 +49,7 @@ def test_basic_processing_2plus1D(self):
4849
}
4950
modeltest = tests.StandardModelTest(model, var_pts=var_pts)
5051
modeltest.test_all(skip_output_tests=True)
52+
pybamm.set_logging_level("WARNING")
5153

5254
def test_optimisations(self):
5355
options = {"thermal": "isothermal"}

tests/unit/test_citations.py

+8
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,14 @@ def test_sulzer_2019(self):
7474
pybamm.lead_acid.Full(build=False)
7575
self.assertIn("sulzer2019physical", citations._papers_to_cite)
7676

77+
def test_scikit_fem(self):
78+
citations = pybamm.citations
79+
80+
citations._reset()
81+
self.assertNotIn("scikit-fem", citations._papers_to_cite)
82+
pybamm.ScikitFiniteElement()
83+
self.assertIn("scikit-fem", citations._papers_to_cite)
84+
7785
def test_parameter_citations(self):
7886
citations = pybamm.citations
7987

0 commit comments

Comments
 (0)