Skip to content

Commit 8dd3519

Browse files
committed
Trying out other readme format
1 parent 8c073a1 commit 8dd3519

2 files changed

Lines changed: 15 additions & 15 deletions

File tree

tutorial/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,43 @@ Running locally will require the dependencies from `requirements.txt`.
99
[↩ Back to the main repository](https://github.com/CardiacModelling/VoltageClampModel)
1010

1111

12-
## Modelling patch-clamp experiments
12+
## 1. Modelling patch-clamp experiments
1313
[![github](./img/github.svg)](./1-modelling-patch-clamp.ipynb)
1414
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/1-modelling-patch-clamp.ipynb)
1515

1616
The first notebook describes the uncompensated patch-clamp set up, and derives an ODE model from the electrical schematics.
1717

18-
## Modelling electronic compensation
18+
## 2. Modelling electronic compensation
1919
[![github](./img/github.svg)](./2-compensation.ipynb)
2020
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/2-compensation.ipynb)
2121

2222
The model is updated to include the compensation circuitry commonly used in patch-clamp amplifiers.
2323

24-
## Simulating a manual patch clamp experiment
24+
## 3. Simulating a manual patch clamp experiment
2525
[![github](./img/github.svg)](./3-simulations.ipynb)
2626
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/3-simulations.ipynb)
2727

2828
We walk through and simulate the early steps of a manual patch-clamp experiment.
2929

30-
## Simplified models
30+
## 4. Simplified models
3131
[![github](./img/github.svg)](./4-simplifications.ipynb)
3232
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/4-simplifications.ipynb)
3333

3434
In the final notebook, we derive simplified models and compare with previous work.
3535

3636
## Resources
3737

38-
[![github](./img/github.svg)](./symbols.ipynb)
39-
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/symbols.ipynb)
40-
**Names and symbols** A table of all symbols, their meanings, and names used in other publications.
38+
- [![github](./img/github.svg)](./symbols.ipynb)
39+
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/symbols.ipynb)
40+
**Names and symbols** A table of all symbols, their meanings, and names used in other publications.
4141

42-
[![github](./img/github.svg)](./tour.ipynb)
43-
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/tour.ipynb)
44-
**Default parameter values** and comments on how to reparameterise the model, are given in the Model Tour.
42+
- [![github](./img/github.svg)](./tour.ipynb)
43+
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/tour.ipynb)
44+
**Default parameter values** and comments on how to reparameterise the model, are given in the Model Tour.
4545

46-
[![github](./img/github.svg)](./references.ipynb)
47-
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/references.ipynb)
48-
**References** and further reading.
46+
- [![github](./img/github.svg)](./references.ipynb)
47+
[![nbviewer](./img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/references.ipynb)
48+
**References** and further reading.
4949

5050
Finally, there are [several appendices](./appendix), which provide background on electronics and details of the model derivation.
5151

tutorial/appendix/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ These appendices provide background or technical details that did not fit the ma
2121
2. [![github](../img/github.svg)](./b-op-amps/2-non-ideal-op-amp.ipynb)
2222
[![nbviewer](../img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/appendix/b-op-amps/2-non-ideal-op-amp.ipynb)
2323
Models of an op amp with a finite speed
24-
3. [![github](../img/github.svg)](./b-op-amps/3-resulting-vc-models.ipynb)[![nbviewer]
25-
(../img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/appendix/b-op-amps/3-resulting-vc-models.ipynb)
24+
3. [![github](../img/github.svg)](./b-op-amps/3-resulting-vc-models.ipynb)
25+
[![nbviewer](../img/nbviewer.svg)](https://nbviewer.jupyter.org/github/CardiacModelling/VoltageClampModel/tree/main/tutorial/appendix/b-op-amps/3-resulting-vc-models.ipynb)
2626
VC models based on different op-amp models
2727

2828
## C: Series resistance compensation

0 commit comments

Comments
 (0)