Skip to content

Commit 607c0ca

Browse files
dweindlLeonardSchmiester
andauthored
Update tutorial (#489)
* Prettify reaction arrows * added Erikas comments * Simons comments * Highlight URLs in pdf * chmod +x compile_tutorial.sh * rewrap, typo Co-authored-by: LeonardSchmiester <[email protected]>
1 parent 167b61b commit 607c0ca

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

doc/compile_tutorial.sh

100644100755
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@
55
pandoc tutorial.rst \
66
-o tutorial.pdf \
77
-V geometry:margin=1.5in -V geometry:a4paper -V fontsize=10pt \
8+
-V urlcolor=cyan \
89
--toc \
910
--pdf-engine pdflatex

doc/tutorial.rst

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ tutorial is available `online <https://github.com/PEtab-dev/PEtab/tree/b50d000a5
4444
== ========================== =============================================
4545
ID Reaction Rate law
4646
== ========================== =============================================
47-
R1 2 STAT5A -> pApA cyt \* BaF3_Epo \* STAT5A^2 \* k_phos
48-
R2 STAT5A + STAT5B -> pApB cyt \* BaF3_Epo \* STAT5A \* STAT5B \* k_phos
49-
R3 2 STAT5B -> pBpB cyt \* BaF3_Epo \* STAT5B^2 \* k_phos
50-
R4 pApA -> nucpApA cyt \* k_imp_homo \* pApA
51-
R5 pApB -> nucpApB cyt \* k_imp_hetero \* pApB
52-
R6 pBpB -> nucpBpB cyt \* k_imp_homo \* pBpB
53-
R7 nucpApA -> 2 STAT5A nuc \* k_exp_homo \* nucpApA
54-
R8 nucpApB -> STAT5A + STAT5B nuc \* k_exp_hetero \* nucpApB
55-
R9 nucpBpB -> 2 STAT5B nuc \* k_exp_homo \* nucpBpB
47+
R1 2 STAT5A pApA cyt \* BaF3_Epo \* STAT5A^2 \* k_phos
48+
R2 STAT5A + STAT5B pApB cyt \* BaF3_Epo \* STAT5A \* STAT5B \* k_phos
49+
R3 2 STAT5B pBpB cyt \* BaF3_Epo \* STAT5B^2 \* k_phos
50+
R4 pApA nucpApA cyt \* k_imp_homo \* pApA
51+
R5 pApB nucpApB cyt \* k_imp_hetero \* pApB
52+
R6 pBpB nucpBpB cyt \* k_imp_homo \* pBpB
53+
R7 nucpApA 2 STAT5A nuc \* k_exp_homo \* nucpApA
54+
R8 nucpApB STAT5A + STAT5B nuc \* k_exp_hetero \* nucpApB
55+
R9 nucpBpB 2 STAT5B nuc \* k_exp_homo \* nucpBpB
5656
== ========================== =============================================
5757

5858
2. Linking model and measurements
@@ -79,21 +79,22 @@ experimental conditions under which a measurement was performed.
7979
2.1 Specifying experimental conditions
8080
--------------------------------------
8181

82-
The measurements were collected under the same experimental condition,
82+
All measurements were collected under the same experimental condition,
8383
which is a stimulation with Epo. This is specified in the experimental
8484
condition PEtab file, a tab-separated values (TSV) file\ [#f1]_,
8585
by providing a condition identifier and listing all condition-specific
8686
parameters and their respective values.
8787

8888
In the problem considered here, the relevant parameter is
8989
``Epo_concentration`` which we want to set to a value of 1.25E-7, as the
90-
only condition-specific parameter. In our example we include data from
91-
only one single experiment, so we would not need to specify it here, but
92-
could set the value in the model or in the parameter table. However,
93-
having it would allow us to easily add measurements from other
90+
only condition-specific parameter. Since in this example we include data from
91+
only one single experiment, it would not be necessary to specify the condition
92+
parameter here, but instead the value could have been also set in the model or
93+
in the parameter table. However, the benefit of specifying it in the condition
94+
table is, that it allows us to easily add measurements from other
9495
experiments performed with different Epo concentrations later on.
9596

96-
The condition table would look as follows:
97+
The condition table looks as follows:
9798

9899
.. table:: Conditions table ``experimental_conditions.tsv``.
99100

@@ -189,16 +190,13 @@ file:
189190
containing any form of STAT5A.
190191

191192
* *noiseFormula* is used to describe the formula for the measurement
192-
noise. Together with *noiseDistribution*\ it defines the noise model. In
193-
this example, we assume additive normally distributed measurement noise.
193+
noise. Together with *noiseDistribution*, it defines the noise model. In
194+
this example, we assume additive, normally distributed measurement noise.
194195
In this scenario, ``noiseParameter1_{observableId}`` is the standard
195196
deviation of the measurement noise. Parameters following this naming
196197
scheme are expected to be overridden in a measurement-specific manner in
197198
the *noiseParameters* column of the measurement table (see below).
198199

199-
* *observableTransformation* defines the scale in which model observable
200-
and measurement data are compared. Here, we assume a linear scale. Other
201-
transformations, such as log10 can also be used.
202200

203201
2.3 Specifying measurements
204202
---------------------------

0 commit comments

Comments
 (0)