From e4504a6d6d6a717d18326917dccb75b80d057f5e Mon Sep 17 00:00:00 2001 From: Caitlin Parke Date: Tue, 20 Aug 2024 18:18:42 -0400 Subject: [PATCH] added docs --- docs/source/api/models/lithium_ion/ecm_split_ocv.rst | 7 +++++++ docs/source/api/models/lithium_ion/index.rst | 1 + .../full_battery_models/lithium_ion/basic_ecm_split_OCV.py | 2 -- 3 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 docs/source/api/models/lithium_ion/ecm_split_ocv.rst diff --git a/docs/source/api/models/lithium_ion/ecm_split_ocv.rst b/docs/source/api/models/lithium_ion/ecm_split_ocv.rst new file mode 100644 index 0000000000..2fcc4d37d8 --- /dev/null +++ b/docs/source/api/models/lithium_ion/ecm_split_ocv.rst @@ -0,0 +1,7 @@ +Equivalent Circuit Model with Split OCV (ECMsplitOCV) +===================================================== + +.. autoclass:: pybamm.lithium_ion.ECMsplitOCV + :members: + +.. footbibliography:: diff --git a/docs/source/api/models/lithium_ion/index.rst b/docs/source/api/models/lithium_ion/index.rst index 1a72c3c662..52efe44d6b 100644 --- a/docs/source/api/models/lithium_ion/index.rst +++ b/docs/source/api/models/lithium_ion/index.rst @@ -12,3 +12,4 @@ Lithium-ion Models msmr yang2017 electrode_soh + ecm_split_ocv diff --git a/src/pybamm/models/full_battery_models/lithium_ion/basic_ecm_split_OCV.py b/src/pybamm/models/full_battery_models/lithium_ion/basic_ecm_split_OCV.py index 19398b4a4f..2869d9b94f 100644 --- a/src/pybamm/models/full_battery_models/lithium_ion/basic_ecm_split_OCV.py +++ b/src/pybamm/models/full_battery_models/lithium_ion/basic_ecm_split_OCV.py @@ -18,8 +18,6 @@ class ECMsplitOCV(pybamm.BaseModel): def __init__(self, name="ECM with split OCV"): super().__init__(name) - # TODO citations - # param = self.param ###################### # Variables