You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/user_guide/fundamentals/index.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
PyBaMM (Python Battery Mathematical Modelling) is an open-source battery simulation package
4
4
written in Python. Our mission is to accelerate battery modelling research by
5
-
providing open-source tools for multi-institutional, interdisciplinary collaboration.
5
+
providing open-source tools for multi-institutional, interdisciplinary collaboration.
6
6
Broadly, PyBaMM consists of
7
7
8
8
1. a framework for writing and solving systems of differential equations,
@@ -12,7 +12,7 @@ Broadly, PyBaMM consists of
12
12
Together, these enable flexible model definitions and fast battery simulations, allowing users to
13
13
explore the effect of different battery designs and modeling assumptions under a variety of operating scenarios.
14
14
15
-
>**NOTE**: This user-guide is a work-in-progress, we hope that this brief but incomplete overview will be useful to you.
15
+
>**NOTE**: This user-guide is a work-in-progress, we hope that this brief but incomplete overview will be useful to you.
16
16
17
17
## Core framework
18
18
@@ -40,7 +40,7 @@ External parameter sets can be linked using entry points (see [](parameter_sets)
40
40
41
41
One of PyBaMM's unique features is the `Experiment` class, which allows users to define synthetic experiments using simple instructions in English
42
42
43
-
```python
43
+
```python
44
44
pybamm.Experiment(
45
45
[
46
46
("Discharge at C/10 for 10 hours or until 3.3 V",
@@ -53,11 +53,11 @@ pybamm.Experiment(
53
53
)
54
54
```
55
55
56
-
The above instruction will conduct a standard discharge / rest / charge / rest cycle three times, with a 10 hour discharge and 1 hour rest at the end of each cycle.
56
+
The above instruction will conduct a standard discharge / rest / charge / rest cycle three times, with a 10 hour discharge and 1 hour rest at the end of each cycle.
57
57
58
58
The `Simulation` class handles simulating an `Experiment`, as well as calculating additional outputs such as capacity as a function of cycle number. For example, the following code will simulate the experiment above and plot the standard output variables:
Users are not limited to these tools and can plot the output of a simulation solution by accessing the underlying numpy array for the solution variables as
Copy file name to clipboardExpand all lines: docs/source/user_guide/getting_started.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,4 +37,4 @@ For new users we recommend the [Getting Started](https://github.com/pybamm-team/
37
37
Further details can be found in a number of [detailed examples](https://github.com/pybamm-team/PyBaMM/blob/develop/examples/notebooks/README.md), hosted on
38
38
GitHub. In addition, full details of classes and methods can be found in the [](api_docs).
0 commit comments