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/tutorial.rst
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -150,14 +150,14 @@ You should see the main window with empty table panels.
150
150
:width:100%
151
151
:align:center
152
152
153
-
PEtab-GUI on first launch - Data Tables tab showing empty tables ready for a new project
153
+
PEtab-GUI on first launch - Data Tables tab showing empty tables ready for a new project.
154
154
155
155
.. figure:: _static/empty_GUI_2.png
156
156
:alt:PEtab-GUI Main Window on First Launch - SBML Model View
157
157
:width:100%
158
158
:align:center
159
159
160
-
PEtab-GUI on first launch - SBML Model tab with empty editors
160
+
PEtab-GUI on first launch - SBML Model tab with empty editors.
161
161
162
162
Step 2: Create the SBML Model
163
163
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -189,7 +189,7 @@ We'll create a simple model using the Antimony editor.
189
189
:width:100%
190
190
:align:center
191
191
192
-
Creating a simple conversion model in Antimony (right panel) and converting it to SBML (left panel)
192
+
Creating a simple conversion model in Antimony (right panel) and converting it to SBML (left panel).
193
193
194
194
**What you should see**: The SBML editor should now contain XML code with ``<listOfSpecies>``, ``<listOfParameters>`` and ``<listOfReactions>`` elements.
195
195
The Info panel at the bottom might show a message confirming the conversion.
@@ -207,7 +207,7 @@ Now we'll import experimental measurements.
207
207
208
208
**Option B: Creating the file yourself**
209
209
210
-
Create a file named ``simple_conversion_measurements.tsv`` with the following content (a tab-separated matrix format):
210
+
Create a file named ``simple_conversion_measurements.tsv`` with the following content (a tab-separated values format):
211
211
212
212
.. code-block:: text
213
213
@@ -223,7 +223,7 @@ Create a file named ``simple_conversion_measurements.tsv`` with the following co
223
223
18 1.6 8.2
224
224
20 1.3 8.5
225
225
226
-
Then drag and drop this file onto the **Measurement Table** panel. When prompted, enter ``SimulationCondition``.
226
+
Then drag and drop this file onto the **Measurement Table** panel. When prompted, enter ``cond_1`` for `Simulation Condition`.
227
227
You should now see the measurements imported, the condition and observables created, but some things are marked red.
228
228
This is the petab linter telling you that some required fields are missing, namely the observable formula, which the GUI
229
229
can not set automatically. We will fix this in the next steps.
@@ -233,7 +233,7 @@ can not set automatically. We will fix this in the next steps.
233
233
:width:100%
234
234
:align:center
235
235
236
-
Dialog when uploading data matrix asking for SimulationConditionId
236
+
Dialog when uploading data matrix asking for SimulationConditionId.
237
237
238
238
**What you should see**: The Measurement Table should now contain 20 rows with your measurement data (10 time points for each of the two species).
239
239
The Info panel will likely show messages about auto-generated observables and conditions.
@@ -243,7 +243,7 @@ The Info panel will likely show messages about auto-generated observables and co
243
243
:width:100%
244
244
:align:center
245
245
246
-
Measurement Table after importing data - 10 time points with measurements for both species A and B
246
+
Measurement Table after importing data - 10 time points with measurements for both species A and B.
247
247
248
248
Step 4: Define the Observable Formulas
249
249
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -274,7 +274,7 @@ You should now see a complete observable table and no more errors in the Info pa
274
274
:width:100%
275
275
:align:center
276
276
277
-
Observable Table with formulas for both species A and B, each with noise standard deviation set to 0.5
277
+
Observable Table with formulas for both species A and B, each with noise standard deviation set to 0.5.
278
278
279
279
**What you should see**: The Info panel might show validation messages confirming the observables are now properly defined.
280
280
@@ -296,9 +296,9 @@ Now we specify which parameters should be estimated and their bounds.
296
296
1. Switch to the **Parameter Table** panel
297
297
2. Click the **"Add Row"** button in the toolbar (or use :menuselection:`&Edit --> Add Row`) or just add it directly
298
298
by double clicking in the first empty row.
299
-
3. Start filling in `k_`, you should automatically be prompted to select `k_conversion` from a dropdown of model parameters.
300
-
4. The `nominalValue` will be taken from your SBML model, the `parameterScale` should be set to `log10` by default and `estimate` should set to 1.
301
-
5. You only need to fill out the lower and upper bounds now. Fill in `0.001` and `100` respectively.
299
+
3. Start filling in ``k_``, you should automatically be prompted to select ``k_conversion`` from a dropdown of model parameters.
300
+
4. The `nominalValue` will be taken from your SBML model, the `parameterScale` should be set to ``log10`` by default and `estimate` should set to ``1``.
301
+
5. You only need to fill out the lower and upper bounds now. Fill in ``0.001`` and ``100`` respectively.
302
302
303
303
.. note::
304
304
@@ -310,7 +310,7 @@ Now we specify which parameters should be estimated and their bounds.
310
310
:width:100%
311
311
:align:center
312
312
313
-
Parameter Table configured for estimating `k_conversion` with bounds [0.001, 100] on log10 scale
313
+
Parameter Table configured for estimating `k_conversion` with bounds [0.001, 100] on log10 scale.
314
314
315
315
**What you should see**: One row in the Parameter Table with all columns filled. Nothing should be colored red anymore.
316
316
@@ -330,7 +330,7 @@ Let's see what our measurement data looks like.
330
330
:width:100%
331
331
:align:center
332
332
333
-
Measurement Plot showing the experimental data - time points vs. measured values for both species A (decreasing) and species B (increasing)
333
+
Measurement Plot showing the experimental data - time points vs. measured values for both species A (decreasing) and species B (increasing).
334
334
335
335
**Try this**: In the :guilabel:`Measurement Table` select one or multiple rows. The corresponding point(s) in the
336
336
:guilabel:`Data Plot` will be highlighted. This linking lets you explore and validate your data early on.
@@ -376,7 +376,7 @@ Congratulations! Your PEtab problem is complete. Now let's save it.
376
376
:width:100%
377
377
:align:center
378
378
379
-
Saving your PEtab problem - choose folder format for easy editing or COMBINE archive for sharing
379
+
Saving your PEtab problem - choose folder format for easy editing or COMBINE archive for sharing.
0 commit comments