Skip to content

Commit

Permalink
fixed doctests
Browse files Browse the repository at this point in the history
  • Loading branch information
santacodes committed Nov 10, 2024
1 parent 2ae38db commit 8da0b01
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 45 deletions.
2 changes: 1 addition & 1 deletion docs/source/api/parameters/parameter_sets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Parameters Sets
PyBaMM provides :ref:`pre-defined parameters <bundled-parameter-sets>` for common
chemistries, as well as, a growing set of :ref:`third-party parameter sets <third-party-parameter-sets>`.

.. autoclass:: pybamm.entry_points.parameter_sets.ParameterSets
.. autoclass:: pybamm.parameters.parameter_sets.ParameterSets
:members:

.. _adding-parameter-sets:
Expand Down
41 changes: 0 additions & 41 deletions docs/source/examples/notebooks/pybamm-cookie.ipynb

This file was deleted.

5 changes: 2 additions & 3 deletions src/pybamm/dispatch/entry_points.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

class EntryPoint(Mapping):
"""
Dict-like interface for accessing parameter sets and models through entry points in copier template.
Access via :py:data:`pybamm.parameter_sets` for parameter_sets
Access via :py:data:`pybamm.Model` for Models
Expand All @@ -17,7 +16,7 @@ class EntryPoint(Mapping):
Listing available parameter sets:
>>> import pybamm
>>> list(pybamm.parameter_sets)
['Ai2020', 'Chen2020', ...]
['Ai2020', 'Chayambuka2022', ...]
>>> list(pybamm.dispatch.models)
['SPM']
Expand All @@ -27,7 +26,7 @@ class EntryPoint(Mapping):
>>> print(pybamm.parameter_sets.get_docstring("Ai2020"))
<BLANKLINE>
Parameters for the Enertech cell (Ai2020), from the papers :footcite:t:`Ai2019`,
:footcite:t:`rieger2016new` and references therein.
:footcite:t:`Rieger2016` and references therein.
...
See also: :ref:`adding-parameter-sets`
Expand Down

0 comments on commit 8da0b01

Please sign in to comment.