Skip to content

Commit 7f7273e

Browse files
committed
#992 update docs
1 parent 698da0c commit 7f7273e

File tree

8 files changed

+24
-3
lines changed

8 files changed

+24
-3
lines changed

docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ API documentation
6666
source/solvers/index
6767
source/experiments/index
6868
source/simulation
69-
source/quick_plot
69+
source/plotting/index
7070
source/util
7171
source/citations
7272
source/parameters_cli

docs/source/plotting/dynamic_plot.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Dynamic Plot
2+
============
3+
4+
.. autofunction:: pybamm.dynamic_plot

docs/source/plotting/index.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Plotting
2+
========
3+
4+
.. toctree::
5+
6+
quick_plot
7+
dynamic_plot
8+
plot
9+
plot_2D

docs/source/plotting/plot.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Plot
2+
====
3+
4+
.. autofunction:: pybamm.plot

docs/source/plotting/plot_2D.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Plot 2D
2+
=======
3+
4+
.. autofunction:: pybamm.plot2D
File renamed without changes.

pybamm/plotting/dynamic_plot.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ def dynamic_plot(*args, **kwargs):
99
Creates a :class:`pybamm.QuickPlot` object (with arguments 'args' and keyword
1010
arguments 'kwargs') and then calls :meth:`pybamm.QuickPlot.dynamic_plot`.
1111
The key-word argument 'testing' is passed to the 'dynamic_plot' method, not the
12-
`QuickPlot' class.
12+
`QuickPlot` class.
1313
1414
Returns
1515
-------

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ def test_compare_outputs_thermal(self):
9999
solutions = []
100100
t_eval = np.linspace(0, 3600, 100)
101101
for model in models:
102-
solution = pybamm.CasadiSolver(dt_max=0.01).solve(model, t_eval)
102+
solution = pybamm.CasadiSolver().solve(model, t_eval)
103103
solutions.append(solution)
104104

105105
# compare outputs

0 commit comments

Comments
 (0)