Skip to content

Commit 9e7a612

Browse files
committed
#57 update generated markdown tutorials
1 parent be59762 commit 9e7a612

8 files changed

+53
-61
lines changed

doc/tutorials/TestCellSortingTutorial.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,17 @@ toc: true
88
layout: "single"
99
---
1010

11-
This tutorial is automatically generated from the file ../test/python/cell_based/tutorials/TestCellSortingTutorial.py .
11+
This tutorial is automatically generated from [TestCellSortingTutorial](https://github.com/Chaste/PyChaste/blob/develop/test/python/cell_based/tutorials/TestCellSortingTutorial.py) at revision [be59762f](https://github.com/Chaste/PyChaste/commit/be59762fe3e4709aa796fb442199fd23cadfd269).
1212
Note that the code is given in full at the bottom of the page.
1313

1414

15-
16-
# Introduction
15+
## Introduction
1716
This test is a demonstration of cell sorting using a Cellular Potts based framework.
1817
It shows:
1918
* How to set up a Potts simulation
2019
* Working with labels
2120

22-
## The Test
21+
### The Test
2322

2423
```python
2524
import unittest # Python testing framework
@@ -34,7 +33,7 @@ import chaste.visualization # Visualization tools
3433
class TestCellSortingTutorial(chaste.cell_based.AbstractCellBasedTestSuite):
3534

3635
```
37-
## Test 1 - Cell sorting
36+
### Test 1 - Cell sorting
3837
The next test generates a collection of cells, there are two types of cells, labelled ones and non labelled ones,
3938
there is differential adhesion between the cell types. For the parameters specified, the cells sort into separate types.
4039

@@ -150,11 +149,11 @@ if __name__ == '__main__':
150149
```
151150

152151

153-
# Code
152+
## Code
154153
The full code is given below
155154

156155

157-
## File name `TestCellSortingTutorial.py`
156+
### File name TestCellSortingTutorial.py
158157

159158
```python
160159
import unittest # Python testing framework

doc/tutorials/TestMeshBasedCellSimulationsPythonTutorial.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,15 @@ toc: true
88
layout: "single"
99
---
1010

11-
This tutorial is automatically generated from the file ../test/python/cell_based/tutorials/TestMeshBasedCellSimulationsPythonTutorial.py .
11+
This tutorial is automatically generated from [TestMeshBasedCellSimulationsPythonTutorial](https://github.com/Chaste/PyChaste/blob/develop/test/python/cell_based/tutorials/TestMeshBasedCellSimulationsPythonTutorial.py) at revision [be59762f](https://github.com/Chaste/PyChaste/commit/be59762fe3e4709aa796fb442199fd23cadfd269).
1212
Note that the code is given in full at the bottom of the page.
1313

1414

15-
16-
# Introduction
15+
## Introduction
1716
In this tutorial we show how Chaste can be used to create, run and visualize mesh-based simulations.
1817
Full details of the mathematical model can be found in van Leeuwen et al. (2009) [doi:10.1111/j.1365-2184.2009.00627.x].
1918

20-
## Imports and Setup
19+
### Imports and Setup
2120

2221
```python
2322
import unittest # Python testing framework
@@ -32,7 +31,7 @@ import chaste.visualization # Visualization tools
3231
class TestRunningMeshBasedSimulationsTutorial(chaste.cell_based.AbstractCellBasedTestSuite):
3332

3433
```
35-
## Test 1 - a basic mesh-based simulation
34+
### Test 1 - a basic mesh-based simulation
3635
In the first test, we run a simple mesh-based simulation,
3736
in which we create a monolayer of cells, using a mutable mesh. Each cell is assigned a stochastic cell-cycle model.
3837

@@ -139,7 +138,7 @@ To run the simulation, we call `Solve()`. We can again do a quick rendering of t
139138
```
140139
Full results can be visualized in Paraview from the `file_handler.GetOutputDirectoryFullPath()` directory.
141140

142-
## Test 2 - a basic mesh-based simulation with ghost nodes
141+
### Test 2 - a basic mesh-based simulation with ghost nodes
143142
In the second test, we run a simple mesh-based simulation with ghost nodes, in which we create a monolayer of cells, using a mutable mesh.
144143
Each cell is assigned a stochastic cell-cycle model.
145144

@@ -256,11 +255,11 @@ if __name__ == '__main__':
256255
```
257256

258257

259-
# Code
258+
## Code
260259
The full code is given below
261260

262261

263-
## File name `TestMeshBasedCellSimulationsPythonTutorial.py`
262+
### File name TestMeshBasedCellSimulationsPythonTutorial.py
264263

265264
```python
266265
import unittest # Python testing framework

doc/tutorials/TestNodeBasedCellSimulationsPythonTutorial.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,15 @@ toc: true
88
layout: "single"
99
---
1010

11-
This tutorial is automatically generated from the file ../test/python/cell_based/tutorials/TestNodeBasedCellSimulationsPythonTutorial.py .
11+
This tutorial is automatically generated from [TestNodeBasedCellSimulationsPythonTutorial](https://github.com/Chaste/PyChaste/blob/develop/test/python/cell_based/tutorials/TestNodeBasedCellSimulationsPythonTutorial.py) at revision [be59762f](https://github.com/Chaste/PyChaste/commit/be59762fe3e4709aa796fb442199fd23cadfd269).
1212
Note that the code is given in full at the bottom of the page.
1313

1414

15-
16-
# Introduction
15+
## Introduction
1716
In this tutorial we show how Chaste can be used to create, run and visualize node-based simulations. Full details of the mechanical model can be found in Pathamathan et
1817
al "A computational study of discrete mechanical tissue models", Physical Biology. Vol. 6. No. 3. 2009.. DOI (10.1088/1478-3975/6/3/036001).
1918

20-
## The Test
19+
### The Test
2120

2221
```python
2322
import unittest # Python testing framework
@@ -30,7 +29,7 @@ chaste.init() # Set up MPI
3029

3130
class TestRunningNodeBasedSimulationsTutorial(chaste.cell_based.AbstractCellBasedTestSuite):
3231
```
33-
## Test 1 - A basic node-based simulation
32+
### Test 1 - A basic node-based simulation
3433
In the first test, we run a simple node-based simulation, in which we create a monolayer of cells,
3534
using a nodes only mesh. Each cell is assigned a uniform cell-cycle model.
3635

@@ -136,7 +135,7 @@ If different simulation input parameters are being explored the lines should be
136135
# JUPYTER_TEARDOWN
137136

138137
```
139-
## Test 2 - a basic node-based simulation in 3D
138+
### Test 2 - a basic node-based simulation in 3D
140139
In the second test we run a simple node-based simulation in 3D. This is very similar to the 2D test with the dimension changed from 2 to 3 and
141140
instead of using a mesh generator we generate the nodes directly.
142141

@@ -238,7 +237,7 @@ If different simulation input parameters are being explored the lines should be
238237
# JUPYTER_TEARDOWN
239238

240239
```
241-
## Test 3 - a node-based simulation on a restricted geometry
240+
### Test 3 - a node-based simulation on a restricted geometry
242241
In the second test we run a simple node-based simulation in 3D. This is very similar to the 2D test with the dimension changed from 2 to 3 and
243242
instead of using a mesh generator we generate the nodes directly.
244243

@@ -339,11 +338,11 @@ if __name__ == '__main__':
339338
```
340339

341340

342-
# Code
341+
## Code
343342
The full code is given below
344343

345344

346-
## File name `TestNodeBasedCellSimulationsPythonTutorial.py`
345+
### File name TestNodeBasedCellSimulationsPythonTutorial.py
347346

348347
```python
349348
import unittest # Python testing framework

doc/tutorials/TestPottsBasedCellSimulationsPythonTutorial.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,15 @@ toc: true
88
layout: "single"
99
---
1010

11-
This tutorial is automatically generated from the file ../test/python/cell_based/tutorials/TestPottsBasedCellSimulationsPythonTutorial.py .
11+
This tutorial is automatically generated from [TestPottsBasedCellSimulationsPythonTutorial](https://github.com/Chaste/PyChaste/blob/develop/test/python/cell_based/tutorials/TestPottsBasedCellSimulationsPythonTutorial.py) at revision [be59762f](https://github.com/Chaste/PyChaste/commit/be59762fe3e4709aa796fb442199fd23cadfd269).
1212
Note that the code is given in full at the bottom of the page.
1313

1414

15-
16-
# Introduction
15+
## Introduction
1716
In this tutorial we show how Chaste can be used to create, run and visualize Potts-based simulations.
1817
Full details of the mathematical model can be found in Graner, F. and Glazier, J. A. (1992).
1918

20-
## The Test
19+
### The Test
2120

2221
```python
2322
import unittest # Python testing framework
@@ -29,7 +28,7 @@ chaste.init() # Set up MPI
2928

3029
class TestRunningPottsBasedSimulationsTutorial(chaste.cell_based.AbstractCellBasedTestSuite):
3130
```
32-
## Test 1 - A basic node-based simulation
31+
### Test 1 - A basic node-based simulation
3332
In the first test, we run a simple Potts-based simulation, in which we create a monolayer of cells, using a Potts mesh.
3433
Each cell is assigned a stochastic cell-cycle model.
3534

@@ -174,7 +173,7 @@ If different simulation input parameters are being explored the lines should be
174173
# JUPYTER_TEARDOWN
175174

176175
```
177-
## Test 2 - Cell sorting
176+
### Test 2 - Cell sorting
178177
The next test generates a collection of cells, there are two types of cells, labelled ones and non labelled ones,
179178
there is differential adhesion between the cell types. For the parameters specified, the cells sort into separate types.
180179

@@ -276,7 +275,7 @@ If different simulation input parameters are being explored the lines should be
276275
# JUPYTER_TEARDOWN
277276

278277
```
279-
## Test 3 - 3D Cell Sorting
278+
### Test 3 - 3D Cell Sorting
280279
The next test extends the previous example to three dimensions.
281280

282281
```python
@@ -384,11 +383,11 @@ if __name__ == '__main__':
384383
```
385384

386385

387-
# Code
386+
## Code
388387
The full code is given below
389388

390389

391-
## File name `TestPottsBasedCellSimulationsPythonTutorial.py`
390+
### File name TestPottsBasedCellSimulationsPythonTutorial.py
392391

393392
```python
394393
import unittest # Python testing framework

doc/tutorials/TestScratchAssayTutorial.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,11 @@ toc: true
88
layout: "single"
99
---
1010

11-
This tutorial is automatically generated from the file ../test/python/cell_based/tutorials/TestScratchAssayTutorial.py .
11+
This tutorial is automatically generated from [TestScratchAssayTutorial](https://github.com/Chaste/PyChaste/blob/develop/test/python/cell_based/tutorials/TestScratchAssayTutorial.py) at revision [be59762f](https://github.com/Chaste/PyChaste/commit/be59762fe3e4709aa796fb442199fd23cadfd269).
1212
Note that the code is given in full at the bottom of the page.
1313

1414

15-
16-
# Introduction
15+
## Introduction
1716
This tutorial is an example of modelling a scratch assay using a simple cellular automaton
1817
representation of cells. It will cover the following techniques:
1918

@@ -37,7 +36,7 @@ import chaste.visualization # Visualization tools
3736
class TestScratchAssayTutorial(chaste.cell_based.AbstractCellBasedTestSuite):
3837

3938
```
40-
## Test 1 - Scratch Assay
39+
### Test 1 - Scratch Assay
4140
In this test we will create a scratch along the middle of a domain and quantify the migration
4241
of cells into the region. Cells will migrate by random walk on the their regular mesh (lattice).
4342

@@ -227,11 +226,11 @@ if __name__ == '__main__':
227226
```
228227

229228

230-
# Code
229+
## Code
231230
The full code is given below
232231

233232

234-
## File name `TestScratchAssayTutorial.py`
233+
### File name TestScratchAssayTutorial.py
235234

236235
```python
237236
import unittest # Python testing framework

doc/tutorials/TestSpheroidTutorial.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,18 @@ toc: true
88
layout: "single"
99
---
1010

11-
This tutorial is automatically generated from the file ../test/python/cell_based/tutorials/TestSpheroidTutorial.py .
11+
This tutorial is automatically generated from [TestSpheroidTutorial](https://github.com/Chaste/PyChaste/blob/develop/test/python/cell_based/tutorials/TestSpheroidTutorial.py) at revision [be59762f](https://github.com/Chaste/PyChaste/commit/be59762fe3e4709aa796fb442199fd23cadfd269).
1212
Note that the code is given in full at the bottom of the page.
1313

1414

15-
16-
# Introduction
15+
## Introduction
1716
This tutorial is an example of modelling spheroid growth with a nutrient.
1817
It covers:
1918
* Setting up an off-lattice cell population
2019
* Setting up a cell cycle model with oxygen dependence
2120
* Setting up and solving an oxygen transport PDE
2221
* Setting up a cell killer
23-
## Imports and Setup
22+
### Imports and Setup
2423

2524
```python
2625
import unittest # Python testing framework
@@ -36,7 +35,7 @@ chaste.init() # Set up MPI
3635
class TestSpheroidTutorial(chaste.cell_based.AbstractCellBasedTestSuite):
3736

3837
```
39-
## Test 1 - a 2D mesh-based spheroid
38+
### Test 1 - a 2D mesh-based spheroid
4039
In this test we set up a spheroid with a plentiful supply of oxygen on the boundary and watch it grow
4140
over time. Cells can gradually become apoptotic if the oxygen tension is too low.
4241

@@ -184,11 +183,11 @@ if __name__ == '__main__':
184183
```
185184

186185

187-
# Code
186+
## Code
188187
The full code is given below
189188

190189

191-
## File name `TestSpheroidTutorial.py`
190+
### File name TestSpheroidTutorial.py
192191

193192
```python
194193
import unittest # Python testing framework

doc/tutorials/TestTensileTestTutorial.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,18 @@ toc: true
88
layout: "single"
99
---
1010

11-
This tutorial is automatically generated from the file ../test/python/cell_based/tutorials/TestTensileTestTutorial.py .
11+
This tutorial is automatically generated from [TestTensileTestTutorial](https://github.com/Chaste/PyChaste/blob/develop/test/python/cell_based/tutorials/TestTensileTestTutorial.py) at revision [be59762f](https://github.com/Chaste/PyChaste/commit/be59762fe3e4709aa796fb442199fd23cadfd269).
1212
Note that the code is given in full at the bottom of the page.
1313

1414

15-
16-
# Introduction
15+
## Introduction
1716
In this tutorial we will demonstrate a simulated tensile test on an epithelial sheet. This test
1817
demonstrates:
1918
* Working with vertex based off lattice populations
2019
* Applying boundary conditions
2120
* Working with forces
2221

23-
## The Test
22+
### The Test
2423

2524
```python
2625
import unittest # Python testing framework
@@ -34,7 +33,7 @@ chaste.init() # Set up MPI
3433
class TestTensileTestTutorial(chaste.cell_based.AbstractCellBasedTestSuite):
3534

3635
```
37-
## Test 1 - A 2d test
36+
### Test 1 - A 2D test
3837

3938
```python
4039
def test_monolayer(self):
@@ -169,11 +168,11 @@ if __name__ == '__main__':
169168
```
170169

171170

172-
# Code
171+
## Code
173172
The full code is given below
174173

175174

176-
## File name `TestTensileTestTutorial.py`
175+
### File name TestTensileTestTutorial.py
177176

178177
```python
179178
import unittest # Python testing framework

0 commit comments

Comments
 (0)