Skip to content

Commit 7d12faa

Browse files
Merge branch 'markdown-docs' of github.com:pybamm-team/PyBaMM into markdown-docs
2 parents 8f45f85 + a4bf0e8 commit 7d12faa

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

docs/source/user_guide/fundamentals/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
PyBaMM (Python Battery Mathematical Modelling) is an open-source battery simulation package
44
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.
66
Broadly, PyBaMM consists of
77

88
1. a framework for writing and solving systems of differential equations,
@@ -12,7 +12,7 @@ Broadly, PyBaMM consists of
1212
Together, these enable flexible model definitions and fast battery simulations, allowing users to
1313
explore the effect of different battery designs and modeling assumptions under a variety of operating scenarios.
1414

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.
1616
1717
## Core framework
1818

@@ -40,7 +40,7 @@ External parameter sets can be linked using entry points (see [](parameter_sets)
4040

4141
One of PyBaMM's unique features is the `Experiment` class, which allows users to define synthetic experiments using simple instructions in English
4242

43-
``` python
43+
```python
4444
pybamm.Experiment(
4545
[
4646
("Discharge at C/10 for 10 hours or until 3.3 V",
@@ -53,11 +53,11 @@ pybamm.Experiment(
5353
)
5454
```
5555

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.
5757

5858
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:
5959

60-
``` python
60+
```python
6161
import pybamm
6262
import matplotlib.pyplot as plt
6363

@@ -75,8 +75,8 @@ Finally, PyBaMM provides cusotm visualization tools:
7575

7676
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
7777

78-
``` python
78+
```python
7979
solution["variable name"].data
8080
```
8181

82-
and using the plotting library of their choice.
82+
and using the plotting library of their choice.

docs/source/user_guide/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ For new users we recommend the [Getting Started](https://github.com/pybamm-team/
3737
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
3838
GitHub. In addition, full details of classes and methods can be found in the [](api_docs).
3939
Additional supporting material can be found
40-
[here](https://github.com/pybamm-team/pybamm-supporting-material/).
40+
[here](https://github.com/pybamm-team/pybamm-supporting-material/).

docs/source/user_guide/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
(user)=
2+
23
# PyBaMM user guide
34

45
This guide is an overview and explains the important features;

0 commit comments

Comments
 (0)