Minor updates.

This commit is contained in:
cjmyers 2011-05-14 20:58:10 +00:00
parent cd022181d2
commit 682a39b3e0
14 changed files with 1165 additions and 182 deletions

View file

@ -14,9 +14,9 @@
<title> LEMA: User's Manual</title>
<title> ATACS User's Manual</title>
<h1 align="center">LEMA: User's Manual </h1>
<h1 align="center">ATACS User's Manual </h1>
<div class="p"><!----></div>
@ -24,11 +24,103 @@
<div class="p"><!----></div>
<h3 align="center">Created: February 20th, 2009<br />
Last Revised: February 20th, 2009
</h3>
<div class="p"><!----></div>
<div class="p"><!----></div>
<h1>Contents </h1><a href="#tth_sEc1"
>1&nbsp; Introduction</a><br />
<a href="#tth_sEc2"
>2&nbsp; Project Management</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.1"
>2.1&nbsp; Creating and Opening Projects</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.2"
>2.2&nbsp; Creating Models and Graphs</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.3"
>2.3&nbsp; Importing Models</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.4"
>2.4&nbsp; Editing Project Objects</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.5"
>2.5&nbsp; Viewing Project Objects</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.6"
>2.6&nbsp; Creating Tool Views</a><br />
<a href="#tth_sEc3"
>3&nbsp; SBML Editor</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.1"
>3.1&nbsp; SBML Math Formulas</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2"
>3.2&nbsp; Main Elements</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2.1"
>3.2.1&nbsp; Compartments</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2.2"
>3.2.2&nbsp; Species</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2.3"
>3.2.3&nbsp; Reactions</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2.4"
>3.2.4&nbsp; Global Parameters</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3"
>3.3&nbsp; Definitions/Types</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3.1"
>3.3.1&nbsp; Function Definitions</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3.2"
>3.3.2&nbsp; Unit Definitions</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3.3"
>3.3.3&nbsp; Compartment Types</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3.4"
>3.3.4&nbsp; Species Types</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4"
>3.4&nbsp; Initial Assignments/Rules/Constraints/Events</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4.1"
>3.4.1&nbsp; Initial Assignments</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4.2"
>3.4.2&nbsp; Rules</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4.3"
>3.4.3&nbsp; Constraints</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4.4"
>3.4.4&nbsp; Events</a><br />
<a href="#tth_sEc4"
>4&nbsp; GCM Editor</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc4.1"
>4.1&nbsp; Promoters</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc4.2"
>4.2&nbsp; GCM Species</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc4.3"
>4.3&nbsp; Influences</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc4.4"
>4.4&nbsp; GCM Parameters</a><br />
<a href="#tth_sEc5"
>5&nbsp; Analysis View</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc5.1"
>5.1&nbsp; Simulation Options</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc5.2"
>5.2&nbsp; Abstraction Options</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc5.3"
>5.3&nbsp; Parameter Editor</a><br />
<a href="#tth_sEc6"
>6&nbsp; Learn View</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc6.1"
>6.1&nbsp; Data Manager</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc6.2"
>6.2&nbsp; Learn Tool</a><br />
<a href="#tth_sEc7"
>7&nbsp; TSD Graph Editor</a><br />
<a href="#tth_sEc8"
>8&nbsp; Probability Graph Editor</a><br />
<a href="#tth_sEc9"
>9&nbsp; Preferences</a><br />
<a href="#tth_sEc10"
>10&nbsp; Genetic Circuit Model Format</a><br />
<a href="#tth_sEc11"
>11&nbsp; Time Series Data Format</a><br />
<a href="#tth_sEc12"
>12&nbsp; List of Hot Keys</a><br />
<a href="#tth_sEc13"
>13&nbsp; Tutorial</a><br />
<a href="#tth_sEc14"
>14&nbsp; Reporting Bugs and Feature Requests</a><br />
<a href="#tth_sEc15"
>15&nbsp; Credits</a><br />
<div class="p"><!----></div>
@ -119,20 +211,20 @@ down menu shown below.
<div class="p"><!----></div>
After you have created or opened a project, you can create a
new model or graph to add to the project. To create a new
Genetic Circuit Model (see Section&nbsp;), select
Genetic Circuit Model (see Section&nbsp;<a href="#GCM">10</a>), select
New &#8594; Genetic Circuit Model from the
File menu as shown below. You will then be prompted to give a model id. At this
point, a GCM editor (see Section&nbsp;) will open in a new
point, a GCM editor (see Section&nbsp;<a href="#GCMEdit">4</a>) will open in a new
tab. To create a new SBML model, select New &#8594; SBML Model
from the File menu. You will then be prompted to give a model id.
At this point, an SBML editor (see Section&nbsp;) will open
At this point, an SBML editor (see Section&nbsp;<a href="#SBMLEdit">3</a>) will open
in a new tab. To create a new TSD graph, select New &#8594; TSD Graph
from the File menu. You will then be prompted to give a name to
the TSD graph. At this point, a TSD graph editor (see Section&nbsp;)
the TSD graph. At this point, a TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>)
will open in a new tab. To create a new probability graph, select
New &#8594; Probability Graph from the File menu. You will then
be prompted to give a name to the probability graph. At this point, a
probability graph editor (see Section&nbsp;)
probability graph editor (see Section&nbsp;<a href="#ProbEdit">8</a>)
will open in a new tab. Once a model or graph is created, it can
be opened again later by right clicking on the object in the
project window and selecting "Edit", or alternatively
@ -175,16 +267,16 @@ All project objects can be modified by highlighting the object
and using a right mouse click to open a menu of options as shown
below. Using this menu, every type of object can be copied, renamed, or
deleted. For a GCM, the "View/Edit" option opens the
model in a GCM editor (see Section&nbsp;). For an SBML model,
model in a GCM editor (see Section&nbsp;<a href="#GCMEdit">4</a>). For an SBML model,
the "View/Edit" option opens the model in an SBML editor
(see Section&nbsp;). For a TSD graph, the "View/Edit"
option opens the TSD graph in a TSD graph editor (see Section&nbsp;).
(see Section&nbsp;<a href="#SBMLEdit">3</a>). For a TSD graph, the "View/Edit"
option opens the TSD graph in a TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>).
For a probability graph, the "View/Edit" option opens
the probability graph in a probability graph editor
(see Section&nbsp;).
(see Section&nbsp;<a href="#ProbEdit">8</a>).
For an analysis view, the "Open Analysis View" option opens the
analysis view (see Section&nbsp;). For a learn view, the
"Open Learn View" option opens the learn view (see Section&nbsp;).
analysis view (see Section&nbsp;<a href="#Analysis">5</a>). For a learn view, the
"Open Learn View" option opens the learn view (see Section&nbsp;<a href="#Learn">6</a>).
<div class="p"><!----></div>
@ -233,8 +325,8 @@ default xhtml browser.
<div class="p"><!----></div>
To perform analysis or learning, right click on a model and
select "Create Analysis View" (see Section&nbsp;)
to perform analysis or "Create Learn View" (see Section&nbsp;)
select "Create Analysis View" (see Section&nbsp;<a href="#Analysis">5</a>)
to perform analysis or "Create Learn View" (see Section&nbsp;<a href="#Learn">6</a>)
to perform learning. You will then be prompted to give a name to
your analysis or learn view. After a name is entered, a tab with
the newly created view will open. Once a view is created, it can
@ -257,8 +349,8 @@ analysis view, you can edit the initial concentrations and
parameters. However, if you wish to be able to edit the
structure, you should first create an SBML model using Create
SBML Model option in the right click menu or the Save as SBML button in
the GCM Editor (see Section&nbsp;). You can then open and
edit this model using an SBML editor (see Section&nbsp;) and
the GCM Editor (see Section&nbsp;<a href="#GCMEdit">4</a>). You can then open and
edit this model using an SBML editor (see Section&nbsp;<a href="#SBMLEdit">3</a>) and
create an analysis view from this edited model.
<div class="p"><!----></div>
@ -269,18 +361,18 @@ create an analysis view from this edited model.
<div class="p"><!----></div>
The SBML editor as shown below allows the user to create or modify an SBML
model of a biochemical reaction network. An SBML model includes
compartments (see Section&nbsp;),
species (see Section&nbsp;),
reactions (see Section&nbsp;),
parameters (see Section&nbsp;),
function definitions (see Section&nbsp;),
unit definitions (see Section&nbsp;),
compartment types (see Section&nbsp;),
species types (see Section&nbsp;),
initial assignments (see Section&nbsp;),
rules (see Section&nbsp;),
constraints (see Section&nbsp;), and
events (see Section&nbsp;).
compartments (see Section&nbsp;<a href="#compartments">3.2.1</a>),
species (see Section&nbsp;<a href="#species">3.2.2</a>),
reactions (see Section&nbsp;<a href="#reactions">3.2.3</a>),
parameters (see Section&nbsp;<a href="#parameters">3.2.4</a>),
function definitions (see Section&nbsp;<a href="#funcDefn">3.3.1</a>),
unit definitions (see Section&nbsp;<a href="#unitDefn">3.3.2</a>),
compartment types (see Section&nbsp;<a href="#compTypes">3.3.3</a>),
species types (see Section&nbsp;<a href="#specTypes">3.3.4</a>),
initial assignments (see Section&nbsp;<a href="#initials">3.4.1</a>),
rules (see Section&nbsp;<a href="#rules">3.4.2</a>),
constraints (see Section&nbsp;<a href="#constraints">3.4.3</a>), and
events (see Section&nbsp;<a href="#events">3.4.4</a>).
Each of these items can be added, removed, or edited.
To add a new item, click on the appropriate add button. You
will then be prompted to provide a unique id and some properties
@ -303,7 +395,7 @@ Note that many checks are done on the fly, so it should be difficult
to create models with consistency problems. However, if a user does
not wish to be warned about undeclared units or does not wish to have
units checked at all can set preferences to turn this off
(see Section&nbsp;). The Save and Check SBML button
(see Section&nbsp;<a href="#Preferences">9</a>). The Save and Check SBML button
though will still present all the unit warnings and errors.
Finally, the Save As button can also be used to store the
model, but in this case, a new model ID will be requested and the
@ -405,10 +497,10 @@ math formula:
<div class="p"><!----></div>
This Main Elements tab shown below is used to specify
compartments (see Section&nbsp;),
species (see Section&nbsp;),
reactions (see Section&nbsp;), and
parameters (see Section&nbsp;).
compartments (see Section&nbsp;<a href="#compartments">3.2.1</a>),
species (see Section&nbsp;<a href="#species">3.2.2</a>),
reactions (see Section&nbsp;<a href="#reactions">3.2.3</a>), and
parameters (see Section&nbsp;<a href="#parameters">3.2.4</a>).
This tab also includes the Model ID which is fixed to be the same as
the filename as well as the Model Name which can be used to provide an
arbitrary string description of the model.
@ -650,10 +742,10 @@ As shown below, a parameter includes the following:
<div class="p"><!----></div>
The Definitions/Types tab shown below allows users to provide
function definitions (see Section&nbsp;),
unit definitions (see Section&nbsp;),
compartment types (see Section&nbsp;), and
species types (see Section&nbsp;).
function definitions (see Section&nbsp;<a href="#funcDefn">3.3.1</a>),
unit definitions (see Section&nbsp;<a href="#unitDefn">3.3.2</a>),
compartment types (see Section&nbsp;<a href="#compTypes">3.3.3</a>), and
species types (see Section&nbsp;<a href="#specTypes">3.3.4</a>).
<center>
<img src="screenshots/DefnTypes.png" alt="screenshots/DefnTypes.png" />
@ -761,10 +853,10 @@ species type includes an ID and an optional name field.
<div class="p"><!----></div>
The <tt>Initial Assignments/Rules/Constraints/Events</tt>
tab as shown below allows users to provide initial assignments
(see Section&nbsp;),
rules (see Section&nbsp;),
constraints (see Section&nbsp;), and
events (see Section&nbsp;).
(see Section&nbsp;<a href="#initials">3.4.1</a>),
rules (see Section&nbsp;<a href="#rules">3.4.2</a>),
constraints (see Section&nbsp;<a href="#constraints">3.4.3</a>), and
events (see Section&nbsp;<a href="#events">3.4.4</a>).
<center>
<img src="screenshots/IRCE.png" alt="screenshots/IRCE.png" />
@ -884,12 +976,12 @@ assignment.
<div class="p"><!----></div>
The GCM editor shown below allows the user to create or modify a GCM
(see Section&nbsp;). A GCM is a compact graphical representation
(see Section&nbsp;<a href="#GCM">10</a>). A GCM is a compact graphical representation
of a genetic circuit which can later be synthesized into an SBML model.
A GCM includes promoters (see Section&nbsp;),
GCM species (see Section&nbsp;),
influences (see Section&nbsp;),
GCM parameters (see Section&nbsp;), and an optional
A GCM includes promoters (see Section&nbsp;<a href="#Promoters">4.1</a>),
GCM species (see Section&nbsp;<a href="#GCMSpecies">4.2</a>),
influences (see Section&nbsp;<a href="#Influences">4.3</a>),
GCM parameters (see Section&nbsp;<a href="#GCMParameters">4.4</a>), and an optional
SBML file. GCM species, influences,
and promoters can be added, removed, or edited. Parameters can only be edited.
An SBML file can also be selected to merge with the SBML generated from a GCM.
@ -1042,7 +1134,7 @@ allows the user an easy way to change all the parameter values in
a convenient location. If a parameter in the GCM is set to
default, it will use the value found in the GCM parameter list.
These defaults can be modified in the user preferences
(see Section&nbsp;). The GCM parameters are listed below:
(see Section&nbsp;<a href="#Preferences">9</a>). The GCM parameters are listed below:
<div class="p"><!----></div>
@ -1091,11 +1183,11 @@ factor </td></tr>
<div class="p"><!----></div>
The analysis view is used to analyze biochemical reaction
network models. The analysis view as shown below includes tabs for
simulation options (see Section&nbsp;),
abstraction options (see Section&nbsp;),
a parameter editor (see Section&nbsp;),
a TSD graph editor (see Section&nbsp;), and a
probability graph editor (see Section&nbsp;).
simulation options (see Section&nbsp;<a href="#simOptions">5.1</a>),
abstraction options (see Section&nbsp;<a href="#absOptions">5.2</a>),
a parameter editor (see Section&nbsp;<a href="#paramEdit">5.3</a>),
a TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>), and a
probability graph editor (see Section&nbsp;<a href="#ProbEdit">8</a>).
<center>
<img src="screenshots/analysisView.png" alt="screenshots/analysisView.png" />
@ -1276,9 +1368,9 @@ to their stop value.
<div class="p"><!----></div>
The learn view is used to discover genetic circuit
connectivity from time series data. The learn view includes tabs
for a data manager (see Section&nbsp;),
a learn tool (see Section&nbsp;), and a
TSD graph editor (see Section&nbsp;).
for a data manager (see Section&nbsp;<a href="#dataManager">6.1</a>),
a learn tool (see Section&nbsp;<a href="#learnTool">6.2</a>), and a
TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>).
<div class="p"><!----></div>
<h3><a name="tth_sEc6.1">
@ -1301,7 +1393,7 @@ current project, and data from the selected view will be copied
into this learn view. Finally, the Import button brings up a file
browser, and it allows you to import a data file from outside
this project. These files can be in time series data (TSD) format
(see Section&nbsp;), comma separated value (CSV) format, or tab
(see Section&nbsp;<a href="#TSD">11</a>), comma separated value (CSV) format, or tab
delimited format (DAT).
<div class="p"><!----></div>
@ -1330,7 +1422,7 @@ Barker's PhD dissertation (UofUtah 2007)
. To use this learn tool, adjust
any options described below, if desired, then press the Save and
Learn button. The resulting genetic circuit is specified using
our Genetic Circuit Model (GCM) Format (see Section&nbsp;) and is shown
our Genetic Circuit Model (GCM) Format (see Section&nbsp;<a href="#GCM">10</a>) and is shown
graphically using GraphViz's Dotty tool. On this tab, there are also
buttons to save the parameters without learning, view the last learned
circuit, save the generated circuit into the project, and view the last run
@ -1609,7 +1701,7 @@ supported file types are:
<div class="p"><!----></div>
</li>
<li> tsd - time series data format (see Section&nbsp;).
<li> tsd - time series data format (see Section&nbsp;<a href="#TSD">11</a>).
<div class="p"><!----></div>
</li>
</ul>
@ -2080,5 +2172,5 @@ Biology in Trento, Italy.
T<sub><font size="-1">E</font></sub>X
by <a href="http://hutchinson.belmont.ma.us/tth/">
T<sub><font size="-1">T</font></sub>H</a>,
version 3.81.<br />On 16 Mar 2011, 18:23.</small>
version 3.81.<br />On 16 Mar 2011, 19:20.</small>
</html>

Binary file not shown.

View file

@ -7,13 +7,13 @@
\usepackage{indentfirst,graphics,alltt,epsfig,color}
\title{LEMA: User's Manual}
\title{ATACS User's Manual}
\author{Chris J. Myers, Kevin Jones, Scott Little, Nicholas Seegmiller, Robert Thacker, David Walter}
\date{Created: February 20th, 2009\\
Last Revised: February 20th, 2009
}
% \date{Created: February 20th, 2009\\
% Last Revised: February 20th, 2009
% }
\begin{document}

View file

@ -14,9 +14,9 @@
<title> LEMA: User's Manual</title>
<title> LEMA User's Manual</title>
<h1 align="center">LEMA: User's Manual </h1>
<h1 align="center">LEMA User's Manual </h1>
<div class="p"><!----></div>
@ -24,11 +24,71 @@
<div class="p"><!----></div>
<h3 align="center">Created: February 20th, 2009<br />
Last Revised: March 13th, 2009
</h3>
<div class="p"><!----></div>
<div class="p"><!----></div>
<h1>Contents </h1><a href="#tth_sEc1"
>1&nbsp; Introduction</a><br />
<a href="#tth_sEc2"
>2&nbsp; Project Management</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.1"
>2.1&nbsp; Creating and Opening Projects</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.2"
>2.2&nbsp; Creating Models and Graphs</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.3"
>2.3&nbsp; Importing Models</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.4"
>2.4&nbsp; Editing Project Objects</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.5"
>2.5&nbsp; Viewing Project Objects</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.6"
>2.6&nbsp; Creating Tool Views</a><br />
<a href="#tth_sEc3"
>3&nbsp; LHPN Editor</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.1"
>3.1&nbsp; Places</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2"
>3.2&nbsp; Transitions</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2.1"
>3.2.1&nbsp; Assignments</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3"
>3.3&nbsp; Variables</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4"
>3.4&nbsp; Control Flow</a><br />
<a href="#tth_sEc4"
>4&nbsp; Text Editor</a><br />
<a href="#tth_sEc5"
>5&nbsp; Verification View</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc5.1"
>5.1&nbsp; Basic Options</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc5.2"
>5.2&nbsp; Advanced Options</a><br />
<a href="#tth_sEc6"
>6&nbsp; Learn View</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc6.1"
>6.1&nbsp; Data Manager</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc6.2"
>6.2&nbsp; Learn Tool</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc6.2.1"
>6.2.1&nbsp; Basic Options</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc6.2.2"
>6.2.2&nbsp; Advanced Options</a><br />
<a href="#tth_sEc7"
>7&nbsp; TSD Graph Editor</a><br />
<a href="#tth_sEc8"
>8&nbsp; Preferences</a><br />
<a href="#tth_sEc9"
>9&nbsp; Labeled Hybrid Petri Net Format</a><br />
<a href="#tth_sEc10"
>10&nbsp; Time Series Data Format</a><br />
<a href="#tth_sEc11"
>11&nbsp; List of Hot Keys</a><br />
<a href="#tth_sEc12"
>12&nbsp; Reporting Bugs and Feature Requests</a><br />
<a href="#tth_sEc13"
>13&nbsp; Credits</a><br />
<div class="p"><!----></div>
@ -122,15 +182,15 @@ new model or graph to add to the project. To create a new
VHDL-AMS model, select New &#8594; VHDL-AMS Model from the
File menu as shown below. You will then be prompted to give a model id. At this
point, a simple text editor will open in a new tab. To create a new LHPN model
(see Section&nbsp;), select New &#8594; Labeled Hybrid Petri Net from
(see Section&nbsp;<a href="#LHPN">9</a>), select New &#8594; Labeled Hybrid Petri Net from
the File menu. You will then be prompted to give a model id. At this point, an
LHPN editor (see Section&nbsp;) will open in a new tab. To create a new
LHPN editor (see Section&nbsp;<a href="#LHPNEdit">3</a>) will open in a new tab. To create a new
Spice model, select New &#8594; Spice Circuit from the File menu. You
will then be prompted to give a model id. At this point, a simple text editor
will open in a new tab. To create a new TSD graph, select New &#8594; TSD
Graph from the File menu. You will then
be prompted to give a name to the TSD graph. At this point, a TSD graph editor
(see Section&nbsp;) will open in a new tab. Once a model or graph is
(see Section&nbsp;<a href="#TSDEdit">7</a>) will open in a new tab. Once a model or graph is
created, it can be opened again later by right clicking on the object in the
project window and selecting "Edit", or alternatively
double-clicking on the object.
@ -167,16 +227,16 @@ All project objects can be modified by highlighting the object
and using a right mouse click to open a menu of options as shown
below. Using this menu, every type of object can be copied, renamed, or
deleted. For an LHPN, the "View/Edit" option opens the
model in an LHPN editor (see Section&nbsp;). For a VHDL-AMS model,
model in an LHPN editor (see Section&nbsp;<a href="#LHPNEdit">3</a>). For a VHDL-AMS model,
the "View/Edit" option opens the model in a simple text editor. For a TSD
graph, the "View/Edit"
option opens the TSD graph in a TSD graph editor (see Section&nbsp;).
option opens the TSD graph in a TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>).
For a probability graph, the "View/Edit" option opens
the probability graph in a histogram editor
(see Section&nbsp;).
For a verification view, the "Open Verification View" option opens the
verification view (see Section&nbsp;). For a learn view, the
"Open Learn View" option opens the learn view (see Section&nbsp;).
verification view (see Section&nbsp;<a href="#Verification">5</a>). For a learn view, the
"Open Learn View" option opens the learn view (see Section&nbsp;<a href="#Learn">6</a>).
<div class="p"><!----></div>
@ -219,8 +279,8 @@ LHPN and viewed using the same "View Model" option.
<div class="p"><!----></div>
To perform verification or learning, right click on a model and
select "Create Verification View" (see Section&nbsp;)to perform
analysis or "Create Learn View" (see Section&nbsp;)
select "Create Verification View" (see Section&nbsp;<a href="#Verification">5</a>)to perform
analysis or "Create Learn View" (see Section&nbsp;<a href="#Learn">6</a>)
to perform learning. A verification or learn view may also be opened by
selecting the model in the file tree and selecting Learn or Verification from
the Tools menu. You will then be prompted to give a name to
@ -250,10 +310,10 @@ automatically created for verification.
<div class="p"><!----></div>
The LHPN editor as shown below allows the user to create or modify an LHPN
model of an analog or mixed-signal circuit. An LHPN model includes
places (see Section&nbsp;),
transitions (see Section&nbsp;),
variables (see Section&nbsp;), and
control flow (see Section&nbsp;).
places (see Section&nbsp;<a href="#places">3.1</a>),
transitions (see Section&nbsp;<a href="#transitions">3.2</a>),
variables (see Section&nbsp;<a href="#variables">3.3</a>), and
control flow (see Section&nbsp;<a href="#controlFlow">3.4</a>).
Each of these items can be added, removed, or edited.
To add a new item, click on the appropriate add button. You
will then be prompted to provide a unique id and some properties
@ -496,8 +556,8 @@ editor.
<div class="p"><!----></div>
The verification view is used to verify the property stated in the LHPN model.
The verification view as shown below includes tabs for
basic options (see Section&nbsp;), and
advanced options (see Section&nbsp;).
basic options (see Section&nbsp;<a href="#basOptions">5.1</a>), and
advanced options (see Section&nbsp;<a href="#advOptions">5.2</a>).
<center>
<img src="screenshots/verificationView.png" alt="screenshots/verificationView.png" />
@ -659,9 +719,9 @@ The other advanced options include
<div class="p"><!----></div>
The learn view is used to generate an LHPN from time series data. The learn
view includes tabs for a data manager (see Section&nbsp;),
a learn tool (see Section&nbsp;), and a
TSD graph editor (see Section&nbsp;).
view includes tabs for a data manager (see Section&nbsp;<a href="#dataManager">6.1</a>),
a learn tool (see Section&nbsp;<a href="#learnTool">6.2</a>), and a
TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>).
<div class="p"><!----></div>
<h3><a name="tth_sEc6.1">
@ -684,7 +744,7 @@ current project, and data from the selected view will be copied
into this learn view. Finally, the Import button brings up a file
browser, and it allows you to import a data file from outside
this project. These files can be in time series data (TSD) format
(see Section&nbsp;), comma separated value (CSV) format, or tab
(see Section&nbsp;<a href="#TSD">10</a>), comma separated value (CSV) format, or tab
delimited format (DAT).
<div class="p"><!----></div>
@ -709,12 +769,12 @@ to record your changes.
The learn tool is used to generate abstract models from the
simulation data entered through the data manager described above. To
use this learn tool, adjust the basic options(see Section
&nbsp;) and advanced options(see Section
&nbsp;), if desired, then press the Save and Learn button.
&nbsp;<a href="#learnBasOptions">6.2.1</a>) and advanced options(see Section
&nbsp;<a href="#learnAdvOptions">6.2.2</a>), if desired, then press the Save and Learn button.
The resulting abstract models in the form of Labeled Hybrid Petri Net
(see Section&nbsp;),VHDL-AMS and Verilog-AMS can be viewed by
(see Section&nbsp;<a href="#LHPN">9</a>),VHDL-AMS and Verilog-AMS can be viewed by
clicking appropriate options in the View Menu. The resulting circuit is
specified using our Labeled Hybrid Petri Net Format (see Section&nbsp;)
specified using our Labeled Hybrid Petri Net Format (see Section&nbsp;<a href="#LHPN">9</a>)
and is shown graphically using GraphViz's Dotty tool. There are also
menu options to save the parameters without learning, view the last learned
models, save the generated models into the project, and view the last run
@ -1008,7 +1068,7 @@ supported file types are:
<div class="p"><!----></div>
</li>
<li> tsd - time series data format (see Section&nbsp;).
<li> tsd - time series data format (see Section&nbsp;<a href="#TSD">10</a>).
<div class="p"><!----></div>
</li>
</ul>
@ -1351,5 +1411,5 @@ Virginia State University.
T<sub><font size="-1">E</font></sub>X
by <a href="http://hutchinson.belmont.ma.us/tth/">
T<sub><font size="-1">T</font></sub>H</a>,
version 3.81.<br />On 16 Mar 2011, 18:23.</small>
version 3.81.<br />On 16 Mar 2011, 19:20.</small>
</html>

Binary file not shown.

View file

@ -7,13 +7,13 @@
\usepackage{indentfirst,graphics,alltt,epsfig,color}
\title{LEMA: User's Manual}
\title{LEMA User's Manual}
\author{Chris J. Myers, Satish Batchu, Kevin Jones, Scott Little, Nicholas Seegmiller, Robert Thacker, David Walter, Zhen Zhang}
\date{Created: February 20th, 2009\\
Last Revised: March 13th, 2009
}
% \date{Created: February 20th, 2009\\
% Last Revised: March 13th, 2009
% }
\begin{document}

View file

@ -14,9 +14,9 @@
<title> iBioSim: User's Manual</title>
<title> iBioSim User's Manual</title>
<h1 align="center">iBioSim: User's Manual </h1>
<h1 align="center">iBioSim User's Manual </h1>
<div class="p"><!----></div>
@ -25,11 +25,103 @@
<div class="p"><!----></div>
<h3 align="center">Created: August 6th, 2008<br />
Last Revised: October 2, 2010
</h3>
<div class="p"><!----></div>
<div class="p"><!----></div>
<h1>Contents </h1><a href="#tth_sEc1"
>1&nbsp; Introduction</a><br />
<a href="#tth_sEc2"
>2&nbsp; Project Management</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.1"
>2.1&nbsp; Creating and Opening Projects</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.2"
>2.2&nbsp; Creating Models and Graphs</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.3"
>2.3&nbsp; Importing Models</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.4"
>2.4&nbsp; Editing Project Objects</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.5"
>2.5&nbsp; Viewing Project Objects</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc2.6"
>2.6&nbsp; Creating Tool Views</a><br />
<a href="#tth_sEc3"
>3&nbsp; SBML Editor</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.1"
>3.1&nbsp; SBML Math Formulas</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2"
>3.2&nbsp; Main Elements</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2.1"
>3.2.1&nbsp; Compartments</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2.2"
>3.2.2&nbsp; Species</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2.3"
>3.2.3&nbsp; Reactions</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.2.4"
>3.2.4&nbsp; Global Parameters</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3"
>3.3&nbsp; Definitions/Types</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3.1"
>3.3.1&nbsp; Function Definitions</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3.2"
>3.3.2&nbsp; Unit Definitions</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3.3"
>3.3.3&nbsp; Compartment Types</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.3.4"
>3.3.4&nbsp; Species Types</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4"
>3.4&nbsp; Initial Assignments/Rules/Constraints/Events</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4.1"
>3.4.1&nbsp; Initial Assignments</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4.2"
>3.4.2&nbsp; Rules</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4.3"
>3.4.3&nbsp; Constraints</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc3.4.4"
>3.4.4&nbsp; Events</a><br />
<a href="#tth_sEc4"
>4&nbsp; GCM Editor</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc4.1"
>4.1&nbsp; Promoters</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc4.2"
>4.2&nbsp; GCM Species</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc4.3"
>4.3&nbsp; Influences</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc4.4"
>4.4&nbsp; GCM Parameters</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc4.5"
>4.5&nbsp; GCM Components</a><br />
<a href="#tth_sEc5"
>5&nbsp; Analysis View</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc5.1"
>5.1&nbsp; Simulation Options</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc5.2"
>5.2&nbsp; Abstraction Options</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc5.3"
>5.3&nbsp; Parameter Editor</a><br />
<a href="#tth_sEc6"
>6&nbsp; Learn View</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc6.1"
>6.1&nbsp; Data Manager</a><br />
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#tth_sEc6.2"
>6.2&nbsp; Learn Tool</a><br />
<a href="#tth_sEc7"
>7&nbsp; TSD Graph Editor</a><br />
<a href="#tth_sEc8"
>8&nbsp; Probability Graph Editor</a><br />
<a href="#tth_sEc9"
>9&nbsp; Preferences</a><br />
<a href="#tth_sEc10"
>10&nbsp; Genetic Circuit Model Format</a><br />
<a href="#tth_sEc11"
>11&nbsp; Time Series Data Format</a><br />
<a href="#tth_sEc12"
>12&nbsp; Tutorial</a><br />
<a href="#tth_sEc13"
>13&nbsp; Reporting Bugs and Feature Requests</a><br />
<a href="#tth_sEc14"
>14&nbsp; Credits</a><br />
<div class="p"><!----></div>
@ -142,20 +234,20 @@ down menu shown below.
<div class="p"><!----></div>
After you have created or opened a project, you can create a
new model or graph to add to the project. To create a new
Genetic Circuit Model (see Section&nbsp;), select
Genetic Circuit Model (see Section&nbsp;<a href="#GCM">10</a>), select
New &#8594; Genetic Circuit Model from the
File menu as shown below. You will then be prompted to give a model id. At this
point, a GCM editor (see Section&nbsp;) will open in a new
point, a GCM editor (see Section&nbsp;<a href="#GCMEdit">4</a>) will open in a new
tab. To create a new SBML model, select New &#8594; SBML Model
from the File menu. You will then be prompted to give a model id.
At this point, an SBML editor (see Section&nbsp;) will open
At this point, an SBML editor (see Section&nbsp;<a href="#SBMLEdit">3</a>) will open
in a new tab. To create a new TSD graph, select New &#8594; TSD Graph
from the File menu. You will then be prompted to give a name to
the TSD graph. At this point, a TSD graph editor (see Section&nbsp;)
the TSD graph. At this point, a TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>)
will open in a new tab. To create a new probability graph, select
New &#8594; Probability Graph from the File menu. You will then
be prompted to give a name to the probability graph. At this point, a
probability graph editor (see Section&nbsp;)
probability graph editor (see Section&nbsp;<a href="#ProbEdit">8</a>)
will open in a new tab. Once a model or graph is created, it can
be opened again later by right clicking on the object in the
project window and selecting "Edit", or alternatively
@ -199,16 +291,16 @@ and using a right mouse click to open a menu of options as shown
below. Using this menu, every type of object can be copied, renamed, or
deleted (these actions can also be done from the Edit menu).
For a GCM, the "View/Edit" option opens the
model in a GCM editor (see Section&nbsp;). For an SBML model,
model in a GCM editor (see Section&nbsp;<a href="#GCMEdit">4</a>). For an SBML model,
the "View/Edit" option opens the model in an SBML editor
(see Section&nbsp;). For a TSD graph, the "View/Edit"
option opens the TSD graph in a TSD graph editor (see Section&nbsp;).
(see Section&nbsp;<a href="#SBMLEdit">3</a>). For a TSD graph, the "View/Edit"
option opens the TSD graph in a TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>).
For a probability graph, the "View/Edit" option opens
the probability graph in a probability graph editor
(see Section&nbsp;).
(see Section&nbsp;<a href="#ProbEdit">8</a>).
For an analysis view, the "Open Analysis View" option opens the
analysis view (see Section&nbsp;). For a learn view, the
"Open Learn View" option opens the learn view (see Section&nbsp;).
analysis view (see Section&nbsp;<a href="#Analysis">5</a>). For a learn view, the
"Open Learn View" option opens the learn view (see Section&nbsp;<a href="#Learn">6</a>).
<div class="p"><!----></div>
@ -258,8 +350,8 @@ View &#8594; Model sub-menu.
<div class="p"><!----></div>
To perform analysis or learning, right click on a model and
select "Create Analysis View" (see Section&nbsp;)
to perform analysis or "Create Learn View" (see Section&nbsp;)
select "Create Analysis View" (see Section&nbsp;<a href="#Analysis">5</a>)
to perform analysis or "Create Learn View" (see Section&nbsp;<a href="#Learn">6</a>)
to perform learning. You will then be prompted to give a name to
your analysis or learn view. After a name is entered, a tab with
the newly created view will open. Views can also be created using the
@ -283,8 +375,8 @@ analysis view, you can edit the initial concentrations and
parameters. However, if you wish to be able to edit the
structure, you should first create an SBML model using Create
SBML Model option in the right click menu or the Save as SBML button in
the GCM Editor (see Section&nbsp;). You can then open and
edit this model using an SBML editor (see Section&nbsp;) and
the GCM Editor (see Section&nbsp;<a href="#GCMEdit">4</a>). You can then open and
edit this model using an SBML editor (see Section&nbsp;<a href="#SBMLEdit">3</a>) and
create an analysis view from this edited model.
<div class="p"><!----></div>
@ -295,18 +387,18 @@ create an analysis view from this edited model.
<div class="p"><!----></div>
The SBML editor as shown below allows the user to create or modify an SBML
model of a biochemical reaction network. An SBML model includes
compartments (see Section&nbsp;),
species (see Section&nbsp;),
reactions (see Section&nbsp;),
parameters (see Section&nbsp;),
function definitions (see Section&nbsp;),
unit definitions (see Section&nbsp;),
compartment types (see Section&nbsp;),
species types (see Section&nbsp;),
initial assignments (see Section&nbsp;),
rules (see Section&nbsp;),
constraints (see Section&nbsp;), and
events (see Section&nbsp;).
compartments (see Section&nbsp;<a href="#compartments">3.2.1</a>),
species (see Section&nbsp;<a href="#species">3.2.2</a>),
reactions (see Section&nbsp;<a href="#reactions">3.2.3</a>),
parameters (see Section&nbsp;<a href="#parameters">3.2.4</a>),
function definitions (see Section&nbsp;<a href="#funcDefn">3.3.1</a>),
unit definitions (see Section&nbsp;<a href="#unitDefn">3.3.2</a>),
compartment types (see Section&nbsp;<a href="#compTypes">3.3.3</a>),
species types (see Section&nbsp;<a href="#specTypes">3.3.4</a>),
initial assignments (see Section&nbsp;<a href="#initials">3.4.1</a>),
rules (see Section&nbsp;<a href="#rules">3.4.2</a>),
constraints (see Section&nbsp;<a href="#constraints">3.4.3</a>), and
events (see Section&nbsp;<a href="#events">3.4.4</a>).
Each of these items can be added, removed, or edited.
To add a new item, click on the appropriate add button. You
will then be prompted to provide a unique id and some properties
@ -329,7 +421,7 @@ Note that many checks are done on the fly, so it should be difficult
to create models with consistency problems. However, if a user does
not wish to be warned about undeclared units or does not wish to have
units checked at all can set preferences to turn this off
(see Section&nbsp;). The save and check button
(see Section&nbsp;<a href="#Preferences">9</a>). The save and check button
though will still present all the unit warnings and errors.
Finally, the disk with a pencil icon can be used to store the
model, but in this case, a new model ID will be requested and the
@ -431,10 +523,10 @@ math formula:
<div class="p"><!----></div>
This Main Elements tab shown below is used to specify
compartments (see Section&nbsp;),
species (see Section&nbsp;),
reactions (see Section&nbsp;), and
parameters (see Section&nbsp;).
compartments (see Section&nbsp;<a href="#compartments">3.2.1</a>),
species (see Section&nbsp;<a href="#species">3.2.2</a>),
reactions (see Section&nbsp;<a href="#reactions">3.2.3</a>), and
parameters (see Section&nbsp;<a href="#parameters">3.2.4</a>).
This tab also includes the Model ID which is fixed to be the same as
the filename as well as the Model Name which can be used to provide an
arbitrary string description of the model.
@ -676,10 +768,10 @@ As shown below, a parameter includes the following:
<div class="p"><!----></div>
The Definitions/Types tab shown below allows users to provide
function definitions (see Section&nbsp;),
unit definitions (see Section&nbsp;),
compartment types (see Section&nbsp;), and
species types (see Section&nbsp;).
function definitions (see Section&nbsp;<a href="#funcDefn">3.3.1</a>),
unit definitions (see Section&nbsp;<a href="#unitDefn">3.3.2</a>),
compartment types (see Section&nbsp;<a href="#compTypes">3.3.3</a>), and
species types (see Section&nbsp;<a href="#specTypes">3.3.4</a>).
<center>
<img src="screenshots/DefnTypes.png" alt="screenshots/DefnTypes.png" />
@ -787,10 +879,10 @@ species type includes an ID and an optional name field.
<div class="p"><!----></div>
The <tt>Initial Assignments/Rules/Constraints/Events</tt>
tab as shown below allows users to provide initial assignments
(see Section&nbsp;),
rules (see Section&nbsp;),
constraints (see Section&nbsp;), and
events (see Section&nbsp;).
(see Section&nbsp;<a href="#initials">3.4.1</a>),
rules (see Section&nbsp;<a href="#rules">3.4.2</a>),
constraints (see Section&nbsp;<a href="#constraints">3.4.3</a>), and
events (see Section&nbsp;<a href="#events">3.4.4</a>).
<center>
<img src="screenshots/IRCE.png" alt="screenshots/IRCE.png" />
@ -910,12 +1002,12 @@ assignment.
<div class="p"><!----></div>
The GCM editor shown below allows the user to create or modify a GCM
(see Section&nbsp;). A GCM is a compact graphical representation
(see Section&nbsp;<a href="#GCM">10</a>). A GCM is a compact graphical representation
of a genetic circuit which can later be synthesized into an SBML model.
A GCM includes promoters (see Section&nbsp;),
GCM species (see Section&nbsp;),
influences (see Section&nbsp;),
GCM parameters (see Section&nbsp;), and an optional
A GCM includes promoters (see Section&nbsp;<a href="#Promoters">4.1</a>),
GCM species (see Section&nbsp;<a href="#GCMSpecies">4.2</a>),
influences (see Section&nbsp;<a href="#Influences">4.3</a>),
GCM parameters (see Section&nbsp;<a href="#GCMParameters">4.4</a>), and an optional
SBML file. GCM species, influences,
and promoters can be added, removed, or edited. Parameters can only be edited.
An SBML file can also be selected to merge with the SBML generated from a GCM.
@ -1070,7 +1162,7 @@ allows the user an easy way to change all the parameter values in
a convenient location. If a parameter in the GCM is set to
default, it will use the value found in the GCM parameter list.
These defaults can be modified in the user preferences
(see Section&nbsp;). The GCM parameters are listed below:
(see Section&nbsp;<a href="#Preferences">9</a>). The GCM parameters are listed below:
<div class="p"><!----></div>
@ -1154,11 +1246,11 @@ associated.
<div class="p"><!----></div>
The analysis view is used to analyze biochemical reaction
network models. The analysis view as shown below includes tabs for
simulation options (see Section&nbsp;),
abstraction options (see Section&nbsp;),
a parameter editor (see Section&nbsp;),
a TSD graph editor (see Section&nbsp;), and a
probability graph editor (see Section&nbsp;).
simulation options (see Section&nbsp;<a href="#simOptions">5.1</a>),
abstraction options (see Section&nbsp;<a href="#absOptions">5.2</a>),
a parameter editor (see Section&nbsp;<a href="#paramEdit">5.3</a>),
a TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>), and a
probability graph editor (see Section&nbsp;<a href="#ProbEdit">8</a>).
The disk icon in the upper-left is used to save the simulation options
while the play button icon is used to run the simulation.
@ -1346,9 +1438,9 @@ to their stop value.
<div class="p"><!----></div>
The learn view is used to discover genetic circuit
connectivity from time series data. The learn view includes tabs
for a data manager (see Section&nbsp;),
a learn tool (see Section&nbsp;), and a
TSD graph editor (see Section&nbsp;).
for a data manager (see Section&nbsp;<a href="#dataManager">6.1</a>),
a learn tool (see Section&nbsp;<a href="#learnTool">6.2</a>), and a
TSD graph editor (see Section&nbsp;<a href="#TSDEdit">7</a>).
<div class="p"><!----></div>
<h3><a name="tth_sEc6.1">
@ -1371,7 +1463,7 @@ current project, and data from the selected view will be copied
into this learn view. Finally, the Import button brings up a file
browser, and it allows you to import a data file from outside
this project. These files can be in time series data (TSD) format
(see Section&nbsp;), comma separated value (CSV) format, or tab
(see Section&nbsp;<a href="#TSD">11</a>), comma separated value (CSV) format, or tab
delimited format (DAT).
<div class="p"><!----></div>
@ -1400,7 +1492,7 @@ Barker's PhD dissertation (UofUtah 2007)
. To use this learn tool, adjust
any options described below, if desired, then press the play button
icon. The resulting genetic circuit is specified using
our Genetic Circuit Model (GCM) Format (see Section&nbsp;) and is shown
our Genetic Circuit Model (GCM) Format (see Section&nbsp;<a href="#GCM">10</a>) and is shown
graphically using GraphViz's Dotty tool. On this tab, one can also
save the parameters without learning, view the last learned
circuit, save the generated circuit into the project, and view the last run
@ -1679,7 +1771,7 @@ supported file types are:
<div class="p"><!----></div>
</li>
<li> tsd - time series data format (see Section&nbsp;).
<li> tsd - time series data format (see Section&nbsp;<a href="#TSD">11</a>).
<div class="p"><!----></div>
</li>
</ul>
@ -2088,5 +2180,5 @@ the University of Texas in Austin.
T<sub><font size="-1">E</font></sub>X
by <a href="http://hutchinson.belmont.ma.us/tth/">
T<sub><font size="-1">T</font></sub>H</a>,
version 3.81.<br />On 16 Mar 2011, 18:22.</small>
version 3.81.<br />On 16 Mar 2011, 19:20.</small>
</html>

Binary file not shown.

View file

@ -7,14 +7,14 @@
\usepackage{indentfirst,graphics,alltt,epsfig,color}
\title{iBioSim: User's Manual}
\title{iBioSim User's Manual}
\author{Chris J. Myers, Nathan Barker, Kevin Jones, Hiroyuki Kuwahara,\\ Curtis
Madsen, Nam Nguyen, Nicolas Roehner, Tyler Patterson}
\date{Created: August 6th, 2008\\
Last Revised: October 2, 2010
}
% \date{Created: August 6th, 2008\\
% Last Revised: October 2, 2010
% }
\begin{document}

View file

@ -14,9 +14,9 @@
<title> iBioSim: Installation Instructions</title>
<title> iBioSim Installation Instructions</title>
<h1 align="center">iBioSim: Installation Instructions </h1>
<h1 align="center">iBioSim Installation Instructions </h1>
<div class="p"><!----></div>
@ -24,11 +24,19 @@
<div class="p"><!----></div>
<h3 align="center">Created: August 11th, 2008<br />
Last Revised: August 14th, 2008
</h3>
<div class="p"><!----></div>
<div class="p"><!----></div>
<h1>Contents </h1><a href="#tth_sEc1"
>1&nbsp; General Requirements</a><br />
<a href="#tth_sEc2"
>2&nbsp; Installation on Windows</a><br />
<a href="#tth_sEc3"
>3&nbsp; Installation on Linux</a><br />
<a href="#tth_sEc4"
>4&nbsp; Installation on MacOS</a><br />
<div class="p"><!----></div>
@ -208,5 +216,5 @@ double-clicking on it.
T<sub><font size="-1">E</font></sub>X
by <a href="http://hutchinson.belmont.ma.us/tth/">
T<sub><font size="-1">T</font></sub>H</a>,
version 3.81.<br />On 16 Mar 2011, 18:23.</small>
version 3.81.<br />On 16 Mar 2011, 19:20.</small>
</html>

Binary file not shown.

View file

@ -7,13 +7,13 @@
\usepackage{indentfirst,graphics,alltt,epsfig,color}
\title{iBioSim: Installation Instructions}
\title{iBioSim Installation Instructions}
\author{Chris J. Myers}
\date{Created: August 11th, 2008\\
Last Revised: August 14th, 2008
}
% \date{Created: August 11th, 2008\\
% Last Revised: August 14th, 2008
% }
\begin{document}

731
docs/iBioSim_Tutorial.html Normal file
View file

@ -0,0 +1,731 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<meta name="GENERATOR" content="TtH 3.81">
<style type="text/css"> div.p { margin-top: 7pt;}</style>
<style type="text/css"><!--
td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
td div.norm {line-height:normal;}
span.roman {font-family: serif; font-style: normal; font-weight: normal;}
span.overacc2 {position: relative; left: .8em; top: -1.2ex;}
span.overacc1 {position: relative; left: .6em; top: -1.2ex;} --></style>
<title> iBioSim Tutorial</title>
<h1 align="center">iBioSim Tutorial </h1>
<div class="p"><!----></div>
<h3 align="center">Chris J. Myers </h3>
<div class="p"><!----></div>
<div class="p"><!----></div>
<div class="p"><!----></div>
<h1>Contents </h1><a href="#tth_sEc1"
>1&nbsp; Introduction</a><br />
<a href="#tth_sEc2"
>2&nbsp; SBML Editor</a><br />
<a href="#tth_sEc3"
>3&nbsp; GCM Editor</a><br />
<a href="#tth_sEc4"
>4&nbsp; Analysis</a><br />
<a href="#tth_sEc5"
>5&nbsp; Probabilistic Analysis</a><br />
<a href="#tth_sEc6"
>6&nbsp; GCM Learning</a><br />
<a href="#tth_sEc7"
>7&nbsp; Genetic Circuit Design</a><br />
<div class="p"><!----></div>
<div class="p"><!----></div>
<h2><a name="tth_sEc1">
1</a>&nbsp;&nbsp;Introduction</h2>
<div class="p"><!----></div>
The example described in this tutorial constructs a simple model for
the <em>cI</em> and <em>cII</em> genes and the P<sub>R</sub> and P<sub>RE</sub>
promoters from the phage &#955; decision circuit. This example
illustrates many of the features of <tt>iBioSim</tt>.
<div class="p"><!----></div>
<div class="p"><!----></div>
<h2><a name="tth_sEc2">
2</a>&nbsp;&nbsp;SBML Editor</h2>
<div class="p"><!----></div>
After starting <tt>iBioSim</tt>, complete the following steps to create
an SBML model for this example:
<ol type="1">
<li> Select <tt>File</tt> &#8594; <tt>New</tt> &#8594; <tt>Project</tt>.
Browse to desired path and create a project named <tt>demo</tt>.
<div class="p"><!----></div>
<img src="screenshots/project.png" alt="screenshots/project.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>File</tt> &#8594; <tt>New</tt> &#8594; <tt>SBML Model</tt>.
Enter <tt>lambda</tt> as the SBML model ID at which point an SBML
editor will open.
<div class="p"><!----></div>
<img src="screenshots/newModel.png" alt="screenshots/newModel.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Highlight the <tt>default</tt> compartment, select <tt>Edit
Compartment</tt>, and change its ID to <tt>Cytoplasm</tt>. Also, change
the units to <tt>volume</tt>.
<div class="p"><!----></div>
<img src="screenshots/compartment.png" alt="screenshots/compartment.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Add Species</tt> and enter <tt>CI</tt> as the ID,
<tt>The lambda repressor</tt> as the name, change the units
to <tt>mole</tt>, and set the <tt>Has Only Substance Units</tt> flag to
true. Select <tt>Add Species</tt> again and enter <tt>CI2</tt> as the ID,
<tt>CI dimer</tt> as the name, change the units to <tt>mole</tt>, and set the
<tt>Has Only Substance Units</tt> flag to true.
<div class="p"><!----></div>
<img src="screenshots/species.png" alt="screenshots/species.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Add Parameter</tt> and enter <tt>nd</tt> as the ID,
<tt>Number of molecules in dimer</tt> as the name, the value to be 2,
and change the units to <tt>dimensionless</tt>.
<div class="p"><!----></div>
<img src="screenshots/parameter.png" alt="screenshots/parameter.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Definitions/Types</tt> tab, and select <tt>Add Unit</tt>
and enter <tt>per_second</tt> as the ID. Select <tt>Add to List</tt>,
select <tt>second</tt> as the kind, change the exponent to &#8722;1,
and click <tt>Add</tt>. Click <tt>Add</tt> in the <tt>Unit Definition Editor</tt>.
Repeat these steps to create a <tt>per_second_mole</tt> unit
(i.e., (second)<sup>&#8722;1</sup>(mole)<sup>&#8722;1</sup>).
<div class="p"><!----></div>
<img src="screenshots/units.png" alt="screenshots/units.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Main Elements</tt> tab. Select <tt>Add Reaction</tt> and
enter <tt>Dimerize_CI</tt> as the ID, <tt>Reaction to dimerize CI</tt> as
the name, and change reversible to <tt>true</tt>.
<div class="p"><!----></div>
<img src="screenshots/reaction.png" alt="screenshots/reaction.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Add Reactant</tt> and select <tt>CI</tt> as the species,
change <tt>Stoichiometry</tt> to <tt>Stoichiometry math</tt>, and set its
value to <tt>nd</tt>.
<div class="p"><!----></div>
<img src="screenshots/reactant.png" alt="screenshots/reactant.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Add Product</tt> and select <tt>CI2</tt> as the species.
Leave the stoichiometry as 1.
<div class="p"><!----></div>
<img src="screenshots/product.png" alt="screenshots/product.png" />
<div class="p"><!----></div>
</li>
<li> Highlight <tt>kf</tt> and select <tt>Edit Selected Parameter</tt>, change
<tt>kf</tt> to <tt>k2f</tt>, and change the units to <tt>per_second_mole</tt>.
Highlight <tt>kr</tt> and select <tt>Edit Selected Parameter</tt>, change
<tt>kr</tt> to <tt>k2r</tt>, and change the units to <tt>per_second</tt>.
<div class="p"><!----></div>
<img src="screenshots/localParam.png" alt="screenshots/localParam.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Use Mass Action</tt>, select <tt>Add</tt>,
and select <tt>Save and Check SBML</tt>. There should be no errors.
<div class="p"><!----></div>
<img src="screenshots/kineticLaw.png" alt="screenshots/kineticLaw.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Highlight <tt>lambda.sbml</tt>, using right mouse button, select
<tt>View Network</tt>.
Highlight <tt>lambda.sbml</tt>, using right mouse button, select
<tt>View in Browser</tt>.
<div class="p"><!----></div>
<img src="screenshots/viewNet.png" alt="screenshots/viewNet.png" /><br />
<table>
<tr><td align="center"><img src="screenshots/viewNetwork.png" alt="screenshots/viewNetwork.png" /> </td><td align="center"><img src="screenshots/viewBrowser.png" alt="screenshots/viewBrowser.png" />
</td></tr></table>
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Go back to the SBML editor complete the construction of the
chemical reaction network shown below:
<br clear="all" /><table border="0" width="95%"><tr><td>
<table border="0" cellspacing="0" cellpadding="0">
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PRE + <span class="roman">RNAP</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>KPRE2</small><!--sup
--><br />&#8596; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PRE_<span class="roman">RNAP</span> </td></tr></table></td><td width="50%"></td></tr>
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PRE + <span class="roman">CII</span> + <span class="roman">RNAP</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>KPRE4</small><!--sup
--><br />&#8596; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PRE_<span class="roman">CII</span>_<span class="roman">RNAP</span> </td></tr></table></td><td width="50%"></td></tr>
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PRE_<span class="roman">RNAP</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>kPREb</small><!--sup
--><br />&#8594; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PRE_<span class="roman">RNAP</span> + n<span class="roman">CI</span> </td></tr></table></td><td width="50%"></td></tr>
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PRE_<span class="roman">CII</span>_<span class="roman">RNAP</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>kPRE</small><!--sup
--><br />&#8594; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PRE_<span class="roman">CII</span>_<span class="roman">RNAP</span> + n<span class="roman">CI</span> </td></tr></table></td><td width="50%"></td></tr>
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PR + <span class="roman">RNAP</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>KOR9</small><!--sup
--><br />&#8596; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PR_<span class="roman">RNAP</span> </td></tr></table></td><td width="50%"></td></tr>
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PR + 2 <span class="roman">CI</span><span class="roman">2</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>KOR10</small><!--sup
--><br />&#8596; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PR_2 <span class="roman">CI</span><span class="roman">2</span> </td></tr></table></td><td width="50%"></td></tr>
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PR_<span class="roman">RNAP</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>kPR</small><!--sup
--><br />&#8594; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
PR_<span class="roman">RNAP</span> + n<span class="roman">CII</span> </td></tr></table></td><td width="50%"></td></tr>
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
2 <span class="roman">CI</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>K2</small><!--sup
--><br />&#8596; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
<span class="roman">CI</span><span class="roman">2</span> </td></tr></table></td><td width="50%"></td></tr>
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
<span class="roman">CI</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>k1</small><!--sup
--><br />&#8594; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
() </td></tr></table></td><td width="50%"></td></tr>
<tr><td width="50%"></td><td nowrap="nowrap" align="right" colspan="1"><table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
<span class="roman">CII</span> </td></tr></table></td><td nowrap="nowrap" align="left">
<table border="0" cellspacing="0" cellpadding="2"><tr><td nowrap="nowrap" align="left">
</td><td nowrap="nowrap" align="center">
<small>k10</small><!--sup
--><br />&#8594; <br />
<small></small>&nbsp;<br /></td><td nowrap="nowrap" align="center">
</td></tr></table></td><td nowrap="nowrap" align="left">
<table><tr><td nowrap="nowrap" align="right" colspan="1">()</td></tr></table></td><td width="50%"></td></tr></table>
</td></tr></table>
<div class="p"><!----></div>
<center>
<table border="1">
<tr><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
Constant </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
Value </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
Constant </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
Value </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
Constant </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
Value </td></tr></table></td></tr><tr><td></td></tr>
<tr><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
KPRE2 </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.01&nbsp;M<sup>&#8722;1</sup> </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
KPRE4 </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.00161&nbsp;M<sup>&#8722;2</sup> </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
kPREb </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.00004&nbsp;<span class="roman">sec</span><sup>&#8722;1</sup> </td></tr></table></td></tr>
<tr><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
kPRE </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.015&nbsp;<span class="roman">sec</span><sup>&#8722;1</sup> </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
KOR9 </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.69422&nbsp;M<sup>&#8722;1</sup> </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
KOR10 </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.06568&nbsp;M<sup>&#8722;2</sup> </td></tr></table></td></tr>
<tr><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
kPR </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.014&nbsp;<span class="roman">sec</span><sup>&#8722;1</sup> </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
K2 </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.1 M<sup>&#8722;1</sup> </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
k1 </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.0007&nbsp;<span class="roman">sec</span><sup>&#8722;1</sup> </td></tr></table></td></tr>
<tr><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
k10 </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
0.002&nbsp;<span class="roman">sec</span><sup>&#8722;1</sup> </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
n </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
10 </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
&nbsp; </td></tr></table></td><td align="center"><table border="0" cellspacing="0" cellpadding="0"><tr><td nowrap="nowrap" align="center">
&nbsp; </td></tr></table></td></tr></table>
<br />
Set an initial amount of 1.0 for PRE and OR, 30.0 for RNAP, and 0.0
for the rest.
</center>
<div class="p"><!----></div>
</li>
</ol>
<div class="p"><!----></div>
<div class="p"><!----></div>
<div class="p"><!----></div>
<h2><a name="tth_sEc3">
3</a>&nbsp;&nbsp;GCM Editor</h2>
<div class="p"><!----></div>
This section describes how to construct a GCM model for this example:
<ol type="1">
<li> Select <tt>File</tt> &#8594; <tt>New</tt> &#8594;
<tt>Genetic Circuit Model</tt>.
Enter <tt>CI_CII</tt> as the GCM model ID at which point a GCM
editor will open.
<div class="p"><!----></div>
<img src="screenshots/newModel.png" alt="screenshots/newModel.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Add Promoter</tt>, enter <tt>PR</tt> as the ID, and press
<tt>Ok</tt>. Next, add the <tt>PRE</tt> promoter in the same way.
<div class="p"><!----></div>
<img src="screenshots/promoter.png" alt="screenshots/promoter.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Add Species</tt>, enter <tt>CI</tt> as the ID, and press
<tt>Ok</tt>. Next, add the <tt>CII</tt> species in the same way.
<div class="p"><!----></div>
<img src="screenshots/GCMspecies.png" alt="screenshots/GCMspecies.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Select <tt>Add Influence</tt>, change the input to <tt>CI</tt>, change
the output to <tt>CII</tt>, change the promoter to <tt>PR</tt>, and the
type to <tt>repression</tt>. Next, add an activation influence between
<tt>CII</tt> and <tt>CI</tt> on promoter <tt>PRE</tt>.
<div class="p"><!----></div>
<img src="screenshots/influence.png" alt="screenshots/influence.png" />
<div class="p"><!----></div>
</li>
<li> Select <tt>Save GCM</tt>, highlight <tt>CI_CII.gcm</tt> file, and
right click to select <tt>View Genetic Circuit</tt>.
<div class="p"><!----></div>
<table>
<tr><td align="center"><img src="screenshots/viewGenNet.png" alt="screenshots/viewGenNet.png" /></td><td align="center"><img src="screenshots/viewGCM.png" alt="screenshots/viewGCM.png" />
</td></tr></table>
<div class="p"><!----></div>
</li>
</ol>
<div class="p"><!----></div>
<h2><a name="tth_sEc4">
4</a>&nbsp;&nbsp;Analysis</h2>
<div class="p"><!----></div>
The following instructions describe how to analyze the GCM file just
created. The SBML file can also be simulated using the following steps.
<ol type="1">
<li> Select <tt>Save GCM</tt>, highlight <tt>CI_CII.gcm</tt> file,
right click to select <tt>Create Analysis View</tt>, and set the
analysis ID to <tt>sim</tt>.
<div class="p"><!----></div>
<img src="screenshots/GCMAnalysis.png" alt="screenshots/GCMAnalysis.png" />
<div class="p"><!----></div>
</li>
<li> In the newly opened window, select <tt>ODE</tt>.
Also, in this window, change the time limit to 2100.0 and print interval
to 10.0. Finally, select <tt>Save and Run</tt> at the bottom of the window.
<div class="p"><!----></div>
<img src="screenshots/analysisView.png" alt="screenshots/analysisView.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> After the simulation completes, click on the <tt>TSD Graph</tt> tab.
Double click on the graph to bring up the graph editor.
Highlight Average, if not already highlighted, select CI and CII,
change the Title to "ODE Simulation Results",
change the X-Axis Label to "Time
(seconds)", and change the Y-Axis Label to "Number of Molecules".
Press the OK button. Click on Export and enter file name of <tt>ode.jpg</tt>.
<div class="p"><!----></div>
<img src="screenshots/odeResults.png" alt="screenshots/odeResults.png" /><br />
<img src="screenshots/odeSimResults.png" alt="screenshots/odeSimResults.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Select the simulation options tab again, select <tt>Monte
Carlo</tt>, change the number of runs to 100, and set the simulation ID
to <tt>ssa</tt>. Click on <tt>Save and Run</tt>. Click on the <tt>TSD
Graph</tt> tab.
Double click on the graph to bring up the graph editor.
Open the ssa simulation directory, and highlight <tt>run-1</tt>.
Select CI and CII, change Title to "SSA Simulation Results",
change the X-Axis Label to "Time (seconds)", and change the Y-Axis
Label to "Number of Molecules". Press the OK button. Click on
Export and enter file name of <tt>ssa-1.jpg</tt>.
Repeat these steps to generate graphs for the average (<tt>
average.jpg</tt>) and standard deviation (<tt>stddev.jpg</tt>).
Note that you can use the "Deselect All" button to
remove all items from the graph.
<div class="p"><!----></div>
<img src="screenshots/ssaResults.png" alt="screenshots/ssaResults.png" /><br />
<img src="screenshots/ssaSimResults.png" alt="screenshots/ssaSimResults.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Click on the parameter editor tab. Highlight the <tt>PR</tt>
species, and select <tt>Edit Species</tt>. Select <tt>Custom</tt> for
the initial amount of <tt>PR</tt> and change it to 5.
Click on the simulation options tab and change the simulation ID to
<tt>ssa5</tt>.
Press the Save and Run button.
Click on the <tt>TSD Graph</tt> tab and following the steps above,
create the
following plots <tt>ssa-1_5.jpg</tt>, <tt>average_5.jpg</tt>, and
<tt>stddev_5.jpg</tt>.
<div class="p"><!----></div>
<img src="screenshots/paramEdit.png" alt="screenshots/paramEdit.png" /><br />
<img src="screenshots/ssaSimResults5.png" alt="screenshots/ssaSimResults5.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Now go back to the parameter editor tab,
and change the initial amount for <tt>PR</tt> to <tt>Sweep</tt>, set
the start to 2, stop to 8, step to 3. Press the save and run
button. Click on the <tt>TSD Graph</tt> tab and double click on the graph to
open the graph editor. Notice the new simulations id's
generated for each of the run with PR of 2, PR of 5, and PR of
8. Deselect all from the current graph, and go and add the
average value of <tt>CI</tt> from each of these simulation runs.
<div class="p"><!----></div>
<img src="screenshots/sweep.png" alt="screenshots/sweep.png" /><br />
<img src="screenshots/sweepPR.png" alt="screenshots/sweepPR.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Go back to the Parameter Editor tab and change <tt>PR</tt> back to
<tt>Original</tt> value type. Go back to the Simulation Options tab,
select <tt>Abstraction</tt> and change the simulation ID to <tt>abs</tt>.
Press <tt>Save and Run</tt> and note that the simulation time should be
substantially faster.
Go back to the <tt>TSD Graph</tt> tab and double click on the graph to bring up
the graph editor. Deselect all and add the average value of <tt>CI</tt>
from both the <tt>abs</tt> and <tt>ssa</tt> simulations.
<div class="p"><!----></div>
</li>
</ol>
<div class="p"><!----></div>
<img src="screenshots/absResults.png" alt="screenshots/absResults.png" />
<div class="p"><!----></div>
<h2><a name="tth_sEc5">
5</a>&nbsp;&nbsp;Probabilistic Analysis</h2>
<div class="p"><!----></div>
This example illustrates how <tt>iBioSim</tt> can be used for
probabilistic analysis.
<ol type="1">
<li> Go back to the GCM editor for <tt>CI_CII</tt>.
Select <tt>Save as SBML Template</tt> and give it the name <tt>
CI_CIIenv</tt>. Use the <tt>SBML File</tt> pulldown menu to select
<tt>CI_CIIenv.sbml</tt> to associate with this GCM. Press the
<tt>Save GCM</tt> button.
<div class="p"><!----></div>
<img src="screenshots/linkSBML.png" alt="screenshots/linkSBML.png" />
<div class="p"><!----></div>
</li>
<li> Double click on the <tt>CI_CIIenv.sbml</tt> file to open it in an
SBML editor. Select the <tt>Initial
Assignments/Rules/Constraints/Events</tt> tab, and select <tt>Add
Constraint</tt>. Add a constraint with ID <tt>CI20</tt>, constraint
<tt>geq(CI, 20)</tt>, and message <tt>CI greater than 20 molecules</tt>.
Repeat these steps to add constraints for CII &#8805; 30, and t &#8805; 200. Be sure to press the <tt>Save SBML</tt> button when you are done.
<div class="p"><!----></div>
<img src="screenshots/constraint.png" alt="screenshots/constraint.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Go back to your analysis view by clicking on the <tt>sim</tt> tab.
Remove the simulation ID and press <tt>Save and Run</tt>. Click on the
<tt>Probability Graph</tt> tab.
Double click on the graph to bring up the probability graph
editor. Change the title to <tt>Probability Results</tt> and the
Y-axis label to <tt>Percent</tt>. Click on the <tt>sim-rep</tt> file on the
left-hand side. Select <tt>CI20</tt>, <tt>CII30</tt>, and <tt>t200</tt> to
graph them. Press <tt>Ok</tt>.
<div class="p"><!----></div>
<img src="screenshots/editProbGraph.png" alt="screenshots/editProbGraph.png" />
<div class="p"><!----></div>
</li>
<li> Export the graph as a jpg file by selecting the <tt>Export</tt>
button and entering the filename <tt>prob.jpg</tt>.
<div class="p"><!----></div>
<img src="screenshots/probResults.png" alt="screenshots/probResults.png" />
<div class="p"><!----></div>
</li>
</ol>
<div class="p"><!----></div>
<h2><a name="tth_sEc6">
6</a>&nbsp;&nbsp;GCM Learning</h2>
<div class="p"><!----></div>
This section describes how a GCM can be learned from time series data.
<ol type="1">
<li> Highlight <tt>CI_CII.gcm</tt>, right click on it, and select
<tt>Create Learn View</tt>. Give the learn view the ID <tt>learn</tt>.
<div class="p"><!----></div>
<img src="screenshots/createLearn.png" alt="screenshots/createLearn.png" />
<div class="p"><!----></div>
</li>
<li> At this point a <tt>Learn View</tt> will open, and you could begin
to add your experimental data. In this demo, we will just utilize our
simulation data as synthetic experimental data. To do this, click
<tt>Copy From View</tt>, and select <tt>sim/ssa</tt>. Highlight
<tt>sim/ssa/run-1.tsd</tt>, and you should see the simulation data for
<tt>CI</tt> and <tt>CII</tt> appear on the right in the data editor.
<div class="p"><!----></div>
<img src="screenshots/dataManager.png" alt="screenshots/dataManager.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Click on the <tt>Learn</tt> tab. Here you can edit the various
learning options. For example, you can either use auto generated
levels or user generated levels for your data encoding. Select
<tt>Use User Generated Levels</tt> which will make the levels below
editable. You can also select how many bins to use. Change the
number of bins for both <tt>CI</tt> and <tt>CII</tt> to 3. At this point,
you can ask the tool to suggest levels by clicking on the <tt>Suggest
Levels</tt> button. Finally, press <tt>Save and Learn</tt> which will
bring up the GCM that has been learned from this experimental data
using Graphviz's dotty program.
<div class="p"><!----></div>
<img src="screenshots/learn.png" alt="screenshots/learn.png" />
<div class="p"><!----></div>
</li>
</ol>
<div class="p"><!----></div>
<h2><a name="tth_sEc7">
7</a>&nbsp;&nbsp;Genetic Circuit Design</h2>
<div class="p"><!----></div>
This last section describes how <tt>iBioSim</tt> can be used to design
genetic logic gates.
<ol type="1">
<li> Select <tt>File &#8594; New &#8594; Genetic Circuit
Model</tt> and give it the ID <tt>gate</tt>.
<div class="p"><!----></div>
</li>
<li> Add promoters <tt>P1</tt> and <tt>P2</tt>, species <tt>A</tt>, <tt>B</tt>,
and <tt>C</tt> (make <tt>A</tt> and <tt>B</tt> type <tt>boundary</tt> and <tt>
C</tt> type normal), and repression influences from <tt>A</tt> to <tt>C</tt> on
<tt>P1</tt> and <tt>B</tt> to <tt>C</tt> on <tt>P2</tt>. Save as an SBML
template named <tt>gateEnv</tt>, and associate that SBML file with this
GCM. Finally, save the GCM.
<div class="p"><!----></div>
</li>
<li> Open <tt>gateEnv.sbml</tt> in an SBML editor. Click on the<br />
<tt>Initial Assignments/Rules/Constraints/Events</tt> tab, and
select <tt>Add Event</tt>.
<div class="p"><!----></div>
</li>
<li> In the event editor, give a trigger of <tt>geq(t,2000)</tt>.
Press <tt>Add Assignment</tt>, select variable <tt>A</tt>, and enter
60 in the <tt>Assignment</tt> field. Press <tt>Add</tt> for the event
assignment and <tt>Add</tt> for the event. Repeat these steps to
create an assignment to <tt>B</tt> of 60 at time 4000. Note that
you may ignore the warnings. These can be suppressed by
changing your preferences and deselecting <tt>Check for
undeclared units in SBML</tt>. Be sure to press <tt>Save SBML</tt>
when you are done.
<div class="p"><!----></div>
</li>
<li> Highlight <tt>gate.gcm</tt>, right-click, and select <tt>Create
Analysis View</tt>. Give it the ID <tt>simGate</tt>.
<div class="p"><!----></div>
</li>
<li> In the analysis view, change the options to
<tt>Monte Carlo</tt>, time limit of 6000, print interval of 30,
runs of 100.
Press <tt>Save and Run</tt>.
<div class="p"><!----></div>
</li>
<li> Select the <tt>TSD Graph</tt> tab and graph the averages of <tt>
A</tt>, <tt>B</tt>, and <tt>C</tt>. The behavior should be that of a Nand
gate.
<div class="p"><!----></div>
<img src="screenshots/nandResults.png" alt="screenshots/nandResults.png" />
<div class="p"><!----></div>
<div class="p"><!----></div>
</li>
<li> Go back to the GCM editor for <tt>gate</tt>. Change the promoter
on the influence from <tt>B</tt> to <tt>C</tt> to <tt>P1</tt>, and save the
GCM. Go back to your analysis view and press <tt>Save and Run</tt>.
The behavior should now be that of a Nor gate.
<div class="p"><!----></div>
<img src="screenshots/norResults.png" alt="screenshots/norResults.png" />
<div class="p"><!----></div>
</li>
</ol>
<div class="p"><!----></div>
<br /><br /><hr /><small>File translated from
T<sub><font size="-1">E</font></sub>X
by <a href="http://hutchinson.belmont.ma.us/tth/">
T<sub><font size="-1">T</font></sub>H</a>,
version 3.81.<br />On 16 Mar 2011, 18:25.</small>
</html>

BIN
docs/iBioSim_Tutorial.pdf Normal file

Binary file not shown.