Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 3392 improve documentation #3474

Merged
merged 10 commits into from
Dec 6, 2023
Merged

Issue 3392 improve documentation #3474

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7aee06e
Added docstring for print_parameter_info method
AbhishekChaudharii Oct 26, 2023
be87f81
PEP8 adherence for One-line docstring
AbhishekChaudharii Oct 26, 2023
3c59897
Mentioned that arrays can be passed as values for drive cycles.
AbhishekChaudharii Oct 27, 2023
9e82990
reverted changes from 3c59897a3ef85e0753997dbb7cc9d3e1c1814835
AbhishekChaudharii Nov 29, 2023
7c5995f
value can be a 2-column array added in steps.py
AbhishekChaudharii Nov 29, 2023
53efe92
style: pre-commit fixes
pre-commit-ci[bot] Nov 29, 2023
ffd36dd
Merge branch 'pybamm-team:develop' into issue_3392_improve_documentation
AbhishekChaudharii Dec 5, 2023
efba2e0
removed cccv_ode
AbhishekChaudharii Dec 5, 2023
6b6ad0d
style: pre-commit fixes
pre-commit-ci[bot] Dec 5, 2023
0aa0358
removed cccv_ode - fix
AbhishekChaudharii Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pybamm/models/base_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,7 @@ def input_parameters(self):
return self._input_parameters

def print_parameter_info(self):
"""Returns parameters used in the model"""
self._parameter_info = ""
parameters = self._find_symbols(pybamm.Parameter)
for param in parameters:
Expand Down
5 changes: 5 additions & 0 deletions pybamm/step/steps.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ def current(value, **kwargs):
----------
value : float
The current value in A.
Value can be a number, a 2-tuple (for cccv_ode), or a 2-column array (for drive cycles)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The current value in A.
Value can be a number, a 2-tuple (for cccv_ode), or a 2-column array (for drive cycles)
The current value in A. It can be a number or a 2-column array (for drive cycles)

The cccv_ode is only possible at the _Step level so does not need to be included here.

This applies to all below.

**kwargs
Any other keyword arguments are passed to the :class:`pybamm.step._Step`
class.
Expand All @@ -142,6 +143,7 @@ def c_rate(value, **kwargs):
----------
value : float
The C-rate value.
Value can be a number, a 2-tuple (for cccv_ode), or a 2-column array (for drive cycles)
**kwargs
Any other keyword arguments are passed to the :class:`pybamm.step._Step`
class.
Expand All @@ -163,6 +165,7 @@ def voltage(value, **kwargs):
----------
value : float
The voltage value in V.
Value can be a number, a 2-tuple (for cccv_ode), or a 2-column array (for drive cycles)
**kwargs
Any other keyword arguments are passed to the :class:`pybamm.step._Step`
class.
Expand All @@ -184,6 +187,7 @@ def power(value, **kwargs):
----------
value : float
The power value in W.
Value can be a number, a 2-tuple (for cccv_ode), or a 2-column array (for drive cycles)
**kwargs
Any other keyword arguments are passed to the :class:`pybamm.step._Step`
class.
Expand All @@ -205,6 +209,7 @@ def resistance(value, **kwargs):
----------
value : float
The resistance value in Ohm.
Value can be a number, a 2-tuple (for cccv_ode), or a 2-column array (for drive cycles)
**kwargs
Any other keyword arguments are passed to the :class:`pybamm.step._Step`
class.
Expand Down
Loading