KaSim, KaSa, & KaDE reference manual
(release 14d1fe2)

Pierre Boutillier, Jérôme Feret, Jean Krivine and Lý Kim Quyên
KappaLanguage.org


corresponding author: jean.krivine@irif.fr

Contents

1 Introduction
 1.1 Preamble
 1.2 The KaSim engine
 1.3 The KaSa static analyser
 1.4 The KaDE ODEs generator
 1.5 Support
2 Installation
 2.1 Using precompiled binaries
 2.2 Obtaining the sources
 2.3 Compilation
 2.4 Compilation of the graphical interface of KaSa and KaDE
3 The kappa language
 3.1 General structure
 3.2 Agent and token signatures
 3.3 Sited-graph pattern: Kappa expression
  3.3.1 Graph syntax
  3.3.2 Pattern syntax
  3.3.3 Link type
 3.4 Rules
  3.4.1 Chemical notation rules
  3.4.2 Edit notation rules
  3.4.3 Hybrid rules
  3.4.4 Rates
  3.4.5 Ambiguous molecularity
 3.5 Variables
 3.6 Initial conditions
4 The command line
 4.1 General usage
 4.2 Main options
 4.3 Advanced options
 4.4 Example
 4.5 Interactivity
5 A simple model
 5.1 ABC.ka
 5.2 Some runs
6 Advanced concepts
 6.1 Perturbation language
  6.1.1 Adding or deleting agents during a simulation
  6.1.2 Get a snapshot of the mixture (to define a new initial state)
  6.1.3 Interrupt simulation
  6.1.4 Changing the value of a token
  6.1.5 Causality analysis
  6.1.6 Flux maps
  6.1.7 Updating kinetic rates on the fly
  6.1.8 Combining several effects in a single perturbation
  6.1.9 Printing values during a simulation
  6.1.10 Add an entry in the output data
 6.2 Implicit signature
 6.3 Simulation packages
 6.4 Simulation parameters configuration
7 The KaSa static analyser
 7.1 General usage
 7.2 Graphical interface
  7.2.1 Launching the interface
  7.2.2 The areas of interests
  7.2.3 The sub-tab Actions
  7.2.4 The sub-tab Output
 7.3 Reachability analysis
 7.4 Local traces
 7.5 Contact map
 7.6 Influence map
8 The KaDE ODEs generator
 8.1 General usage
 8.2 Graphical interface
  8.2.1 Launching the interface
  8.2.2 The areas of interests
  8.2.3 The sub-tab Data set
  8.2.4 The sub-tab Output
  8.2.5 The sub-tab Integration settings
  8.2.6 The sub-tab Debug
 8.3 Differential semantics
  8.3.1 From rules to reactions

List of Tables

3.1 Agent signatureexpression
3.2 Kappa expressions
3.3 Token expressions
3.4 Example of kinetic rates.
3.5 Rate expressions
3.6 Algebraic expressions
3.7 Symbol usable in algebraic expressions
4.1 Command line: main options
4.2 Command line: advanced options
6.1 Perturbation expressions
6.2 User defined parameters

Chapter 1
Introduction

PIC

1.1 Preamble

This manual describes the usage of KaSim and KaSa, the latest implementation of Kappa, one member of the growing family of rule-based languages. Rule-based modelling has attracted recent attention in developing biological models that are concise, comprehensible, easily extensible, and allows one to deal with the combinatorial complexity of multi-state and multi-component biological molecules. Although this manual contains a self-contained description of Kappa, it is not intended as a tutorial on rule-based modeling.

To get an idea of how Kappa is used in a modeling context, the reader can consult the following note Agile modelling of cellular signalling (SOS’08). A longer article, expounding on causal analysis is also available: Rule-based modelling of cellular signalling (CONCUR’07). See also this tutorial: Modelling epigenetic information maintenance: a Kappa tutorial.

1.2 The KaSim engine

KaSim is an open source stochastic simulator of rule-based models [???] written in Kappa. The Kappa language describes site graphs and their local transformations. KaSim takes one or several Kappa files as input and generates stochastic trajectories of various observables. KaSim implements Danos et al’s implicit state simulation algorithm [?] which adapts Gillespie’s algorithm [??] to rule-based models.

A simulation event corresponds to the application of a rewriting rule, contained in the Kappa files, to the current graph (also called a mixture). At each step, the next event is selected with a probability which is proportional to the rate of the rule it is an event of. If there are no events, that is to say if none of the rules apply to the current state of the system, one has a deadlock. Note that a given rule will in general apply in many different ways; one says it has many instances. The activity of a rule is the number of its instances in the current mixture multiplied by its rate. The probability that the next event is associated to a given rule is therefore proportional to the activity of the rule. Rule activities are updated at each step (see Fig. 1.1). Importantly, the cost of a simulation event is bounded by a constant that is independent of the size of the graph it is applied to [?].


PIC

Figure 1.1: The event loop


Note that KaSim can only render curves in the svg format. However, data outputs given in a text format can be displayed using any standard plotting software such as gnuplot.

1.3 The KaSa static analyser

KaSa is an open source static analyser tool of rule-based models [???] written in Kappa. KaSa takes one or several Kappa files as input and some command line options to toggle on/off some specific static analysis. Currently, KaSa can compute the contact map and the influence map. It can perform reachability analysis [??] as well. Other analyses including model reduction [???] will come soon.

A graphical interface is proposed to navigate through the various options and utilities of KaSa. The compilation of this interface requires labltk and, in particular, tk-dev.

1.4 The KaDE ODEs generator

KaDE is an open source tool to compile rule-based models [???] written in Kappa into systems of ordinary differential equations, or equivalently into reaction networks. It also supports some model reduction techniques, that may reduce the dimension of the ODEs (or the number of different bio-molecular species in reaction networks).

KaDE takes one or several Kappa files as input and some command line options to select a backend format, some semantics options, and some model reduction methods.

A graphical interface is proposed to navigate through the various options and utilities of KaDE. The compilation of this interface requires labltk and, in particular, tk-dev.

1.5 Support

Chapter 2
Installation

2.1 Using precompiled binaries

The easiest way to use KaSim and KaSa is to use pre-compiled versions available in the release section on the github repository (https://github.com/Kappa-_Dev/KaSim/releases). Download the version that corresponds to your operating system (Windows, Linux or Mac OSX) and rename the downloaded file into KaSim and KaSa. Note that on Mac OSX or Linux, it might be necessary to give executable permissions to KaSim and KaSa. This can be done using the shell commands: chmod u+x KaSim and chmod u+x KaSa

To test whether your program does work, simply type ./KaSim --version on a terminal, from the directory that contains the binaries. If the version is displayed it means that the binaries are indeed compatible with your OS. Otherwise you may need to compile KaSim from the sources (see next Section).

2.2 Obtaining the sources

To obtain KaSim/KaSa you can either use pre-compiled binaries (see previous section) or compile the sources for your architecture by yourself.

To do so, download the source code from https://github.com/Kappa-_Dev/KaSim, make sure you have a recent OCaml compiler (KaSim/KaSa currently requires Ocaml 4.02.3 to compile) as well as ocamlbuild, findlib and the yojson library installed.

You can check if it is the case from a terminal window by typing first ocamlfind ocamlopt -v. If it fails or prints a version number too old, then you need to install Ocaml Native compiler that can be downloaded from http://caml.inria.fr/download.en.html and/or findlib available at http://projects.camlcity.org/projects/findlib.html.

Then, type ocamlfind query yojson. The answer should be a path. If it is not, install yojson using a package manager.

Ocamlbuild is hosted on https://github.com/ocaml/ocamlbuild.

2.3 Compilation

Once OCaml is safely installed, untar KaSim archive and compile following these few steps:

At the end of these steps you should see, in the bin directory of the Kappa directory, an executable file named KaSim. In order to check the compilation went fine, simply type bin/KaSim --version.

If the tool ocamlbuild is not in your path, you may set the variable OCAMLBINPATH to point to the location of the compiler by doing make OCAMLBINPATH=’the_correct_dir’ bin/KaSim.

2.4 Compilation of the graphical interface of KaSa and KaDE

The graphical interface of KaSa and KaDE requires tk-dev and labltk. By default, the graphical interface is not compiled. The compilation of this interface can be toggled on by using the following command: make USE_TK=1 bin/KaSa (or make USE_TK=1 bin/KaDE).

Common compilation errors are the following:

  1. The following error:
    /usr/bin/ld: cannot find -ltk  
    collect2: error: ld returned 1 exit status  
    File "caml_startup", line 1:  
    Error: Error during linking  
    Command exited with code 2.

    occurs when the module tk-dev is not installed.

  2. The following error:
    File "_none_", line 1:  
    Error: Cannot find file jpflib.cmxa  
    Command exited with code 2.

    occurs when ocaml cannot link the labltk library.

    Please document the variable LABLTKLIBREP in the Makefile.

Chapter 3
The kappa language

3.1 General structure

A model is represented in Kappa by a set of Kappa File. We use KF to denote the union of the files that are given as input (to either KaSim or KaSa).

Each line of the KF is interpreted as a declaration except if the line ends by the ' ' character. Therefore, in order to write a declaration on several lines, ends every by the last of the lines with a .

Declarations can be: agent and token signatures (Sec. 3.2), rules (Sec. 3.4), variables (Sec. 3.5), initial conditions (Sec. 3.6), perturbations (Sec. 6.1) and parameter configurations (Sec. 6.4).

The KF’s structure is quite flexible. Neither dividing into several sub-files nor the order of declarations matters (to the exception of perturbations and variable declarations, see respectively Sections 6.1 and 3.5 for details).

Comments can be used either by inserting the marker # that tells KaSim to ignore the rest of the line or by putting any text between the delimiters /* and */. The combined use of and # is an alternative way to write comments in the middle of a declaration.

3.2 Agent and token signatures

In Kappa there are two entities that can be used for representing biological elements: agents and tokens. Agents are used to represent complex molecules that may bind to other molecules on specific sites. Tokens are typically used to represent small particles such as ions, ATP, etc. Tokens cannot bind to each other, they can only appear or disappear. In a given model, agents always have a discrete number of instances while tokens may have a continuous concentration.

In order to use agents or tokens in a model, one needs to declare them first. Agent signatures constitute a form of typing information about the agents that are used in the model. It contains information about the name and number of interaction sites the agent has, and about their possible internal states. A signature is declared in the KF by the following line:

according to the grammar given Table 3.1 where terminal symbols are written in (blue) typed font, and 𝜀 stands for the empty list. An identifier Id can be any string generated by a regular expression of the type [a-zA-Z][a-zA-Z0-9_ +].


Table 3.1: Agent signatureexpression
signature_expression ::= Id(sig)
sig ::= Id internal_state_list, sig 𝜀
internal_state_list ::= ~Id internal_state_list 𝜀

For instance the line:

1%agent: A(x,y~u~p,z~0~1~2) # Signature of agent A

will declare an agent A with 3 (interaction) sites x,y and z with the site y possessing two internal states u and p (for instance for the unphosphorylated and phosphorylated forms of y) and the site z having three possible states 0, 1 and 2. Note that internal states values are treated as untyped symbols by KaSim, so choosing a character or an integer as internal state is purely a matter of convention.

Token signatures are declared using a statement of the form:

1%token: ca+ # Signature of calcium token

3.3 Sited-graph pattern: Kappa expression

The state of the system is represented in Kappa as a sited graph: a graph were edges specifies a site of the node they use. You must think as sites as resources. At most one edge of the graph can use a site of a node (representing an agent in our case). We call this concept the rigidity of Kappa.

3.3.1 Graph syntax

The ascii syntax we use to represent sited graphs follows the skeletons (describe formaly in fig 3.2):

3.3.2 Pattern syntax

Kappa strength is to describe transformations by only mentionning (and storing) the relevant part of the subgraph required for that transfor;ation to be possible. It plays a key role in resisting combinatorial explosion when writing models. We use the don’t care, don’t write (DCDW) principle. If a transformation occurs independently of the state of a site of an agent, don’t mention it in the pattern to match. The pattern A(x,z) represents an agent of type A whose sites x and z are free but the sites y and z can be in any internal state and the site y can be linked or not to anything.

If the link state of a site does not matter but the internal state does, an ’?’ has to be added after the site name (and internal state). An agent A whose sites x and z are free, y is in state u and z in state 2 is written A(x,y~u?,z~2).


Table 3.2: Kappa expressions
kappa_expression ::= agent_expression , kappa_expression 𝜀
agent_expression ::= Id(interface)
interface ::= Id internal_state link_state , interface 𝜀
internal_state ::= 𝜀 | ~Id
link_state ::= 𝜀 | !n | !_ | ? | !Id.Id

3.3.3 Link type

In standard kappa, in order to require a site to be bound for an interaction to occur, one may use the semi-link construct !_ which does not specify who the partner of the bond is. For instance in the variable: %var: \var{ab}~|A(x!_),B(y!_)| will count the number of As and Bs connected to someone, including the limit case A(x!1),B(y!1). It is sometimes convenient to specify the type of the semi-link, in order to restrict the choice of the binding partner. For instance the variable: %var: \var{ab}~|A(x!y.B),B(y!x.A)|! will count the number of As whose site x is connected to a site y of B, plus the number of Bs whose site y is connected to a site x of A. Note that this still includes the case A(x!1),B(y!1).

Remark Transformations on semi-links and links type induce side effects (effect on unmention agents/unmentionned site of agent) and can even don’t make sense at all. What would mean to remove the link to A but not the link to B in the example above? Be carefull when you use them.

3.4 Rules

Once agents are declared, one may add to the KF the rules that describe their dynamics.

There are 2 ways of specifing rules:

  1. by giving two kappa_expressions. The first one, called left hand side (LHS), represents what you need to apply the rule. The second, the right hand side (RHS), describes what you obtain once the rule is applied. In Kappa, the 2 are separeted by a following the chemical intuition this notation comes from.
  2. by giving one kappa_expression with edition. The kappa expression still represents the necessary context for the rule to apply but modifications are specified locally inside the expression.

Both are allowed in kappa and are described in the 2 next subsections.

In any case, rule specification is optionnaly prefixed by a rule name (written between ') and always followed by a rule rate. Rate expressions (which include algebraic expressions) are given by the grammars Table 3.5 and Table 3.6 (respectively) but can be thought of for now as positive real numbers.

A complete rule in the first representation looks like:

One may also declare a bi-directional rule using the convention:

The above declaration is equivalent to writing, in addition of 'my-rule', another rule named 'my rule_op' which swaps left and right hand sides, and has rate rate.

It is possible to mix agents and tokens in hybrid rules (which may also be bi-directional). A hybrid rule has the following form:

Token expressions are also given by the grammar in Table 3.3.


Table 3.3: Token expressions
token_expression ::= algebraic_expression:token_name
| token_expression + token_expression
token_name ::= Id

3.4.1 Chemical notation rules

This is the more intuitive representation. Never the less, as the second paragraph will explain, it is error prone. It also induce duplication of the unmodified context between LHS and RHS which can lead to even more errors when edition a posteriori on the left are not correctly reported on the right.

A simple rule

With the signature of A defined in the previous section, the line

1Adimerization A(x),A(y~p) -> A(x!1),A(y~p!1) @ gamma

declares a dimerization rule between two instances of agent A provided the second is phosphorylated (say that is here the meaning of p) on site y).

Remember that the identifier !1 of the bound is arbitrary and that following (DCDW), the site z of A is not mentioned in the expression because it has no influence on the triggering of this rule.

Degradation and synthesis

In the right hand side of a rule, the k-th agent is supposed to correspond to the (transformed) k-th agent of the left hand side. If you put more agent on the left, supernumerary agents are deleted. If you put more on the right, agents are created.

Sticking with A’s signature, one can express that an unphosphoralated A can collapse if not linked to anyone (regardless of the state of z) by writing

1destroyA A(x,y~u,z) -> @ gamma

Similarly, the rule

1buildingA A(z) -> A(z!1),A(x!1) @ gamma

indicates that an agent A free on site z, no matter what its internal state is, may beget a new copy of A bound to it via site x.

Note that in the RHS, the interface of the new copy is not completely described. Following the DCDW convention, KaSim will then assume that the sites that are not mentioned are created in the default state, ie they appear free of any bond and their internal state (if any) is the first of the list shown in the signature (here state u for y and 0 for z).

Determining which agents are kept (potentially transformed), which are deleted, which are created is in fact a bit tricky. KaSim respects the longest prefix convention to determine which agent in the RHS stems from an agent in the LHS. In a word, from a rule of the form a1,,an b1,,bk, with ais and bjs being agents, one computes the largest i n,k such that the agents a1,,ai are pairwise consistent with b1,,bi, ie the ajs and bjs have the same name and the same sites. In which case we say that for all j i, aj is preserved by the transition and for all j > i, aj is deleted by the transition and bj is created by the transition.

This convention makes

1deletingA A(x!1),A(z!1) -> A(x) @ gamma

and

1weird A(z!1),A(x!1) -> A(x) @ gamma

extremely different.

The first one removes the A agent in the mixture that will match the second occurrence of A in the rule (the one that used to be linked on z) and it leaves the other sites than x of the first A untouched. The second one will delete both As and create a fresh new A with all its site free. Side-effects (explained right below) are dramatically different.

Side effects

It may happen that the application of a rule has some side effects on agents that are not mentioned explicitly in the rule. Consider for instance the previous rule:

1deletingA A(x!1),A(z!1) -> A(x) @ gamma

The A in the graph that is matched to the second occurrence of A in the LHS will be deleted by the rule. As a consequence all its sites will disappear together with the bonds that were pointing to them. For instance, when applied to the graph

the above rule will result in a new graph G = A(x!1,y~p,z~2),C(t) where the site t of C is now free as side effect.

Wildcard symbols for link state ? (for bound or not), !_ (for bound to someone), may also induce side effects when they are not preserved in the RHS of a rule, as in

1DisconnectA A(x!_) -> A(x) @ gamma

or

1ForcebindA A(x?),C(t) -> A(x!1),C(t!1) @ gamma

Both these rule will cause KaSim to raise a warning at rule compilation time.

3.4.2 Edit notation rules

Near any modified element, modification is specified. Created agents are prefixed by a +. Degraded agents are prefixed by a . Site modification are described by writing the new (linking or internal) state after a . Therefore, alone means that the site becomes free, !9 means that the site becomes part of link 9 and ˜zzz means that the new internal state of the site is zzz.

Here are all the rules mentionned above (+1 extra) translated in this unambiguous notation:

1Adimerization A(x/!1),A(y~p/!1) @ gamma 
2destroyA -A(x,y~u,z) @ gamma 
3buildingA A(z/!1), +A(x!1) @ gamma 
4deletingA A(x!1/), -A(z!1) @ gamma 
5weird -A(z!1), -A(x!1), +A(x) @ gamma 
6DisconnectA A(x!_/) @ gamma 
7ForcebindA A(x?/!1), C(t/!1) @ gamma 
8phosC C(x1~u/~p!1/),A(c!1/) @ modrate

3.4.3 Hybrid rules

Using Kappa hybrid rules, one may declare that an action has effects on the concentration of some particles of the system. For instance a rule may consume atp, calcium ions etc. It would be a waste of memory and time to use discrete agents to represent such particles. Instead one may declare tokens using declarations of the form:

1%token: atp 
2%token: adp

One may then use these tokens in conjunction with a classical rule using the hybrid format:

1hybridrule S(x~u!1),K(y!1) | 0.2:atp -> S(x~p),K(y) | 0.1:adp @ k

When applied, the above rule will consume 0.2 atp token and produce 0.1 adp token. Note that as specified by the grammar given Table 3.3, the number of consumed (and produced) tokens can be given by a sum of the form:

where each ai,ai is an arbitrary algebraic expression (see Table 3.6) and each ti,ti is a declared token. In the above hybrid rule, calling ni,ni the evaluation of ai and ai, the concentration of token ti will decrease from ni and the concentration of token ti will increase from ni. Importantly, the activity of a hybrid rule like the above one is still defined by |lhs|*r, where |lhs| is the number of embeddings of the lhs of the rule in the mixture, and does not take into account the concentration of the tokens it mentions. As we will see in the next section, it is however possible to make its rate explicitly depend on the concentrations of the tokens using a variable rate.

Consuming t tokens is strickly equivalent to produicing k tokens. So, all variation in amount of tokens can be written on the right hand side of rules. This is what you do when you use tokens in edit notation:

1hybridrule S(x~u/~p!1/),K(y!1/) | (-0.1):atp @ k

Also, speaking only about variation makes clear that the simulator does not check that the consumed amount of token is available. It consumes it even if the quantity becomes then negative!

3.4.4 Rates

As said earlier, Kappa rules are equipped with one or two kinetic rate(s). A rate is a real number, or an algebraic expression evaluated as such, called the individual-based or stochastic rate constant, it is the rate at which the corresponding rule is applied per instance of the rule. Its dimension is the inverse of a time [T1].

The stochastic rate is related to the concentration-based rate constant k of the rule of interest by the following relation:

k = γ(𝒜V )(a1) (3.1)

where V is the volume where the model is considered, 𝒜 = 6.022 1023 is Avogadro’ s number, a 0 is the arity of the rule (ie 2 for a bimolecular rule).

In a modeling context, the constant k is typically expressed using molars M := molesl1 (or variants thereof such as μM, nM), and seconds or minutes. If we choose molars and seconds, k’ s unit is M1as1, as follows from the relation above.

Concentration-based rates are usually favored for measurements and/or deterministic models, so it is useful to know how to convert them into individual-based ones used by KaSim. Here are typical volumes used in modeling:

The table below lists typical ranges for deterministic rate constants and their stochastic counterparts assuming a mammalian cell volume.


Table 3.4: Example of kinetic rates.
process k γ
general binding 107 109 105 103
general unbinding 103 101 103 101
dephosphorylation 1 1
phosphorylation 0.1 0.1
receptor dimerization 2106 1.6106
receptor dissociation 1.6101 1.6101

3.4.5 Ambiguous molecularity

It is considered malpractice to use a Kappa rule of the form A(x),B(y) @ γ in a model where this rule could be applied in a context where A and B are sometimes already connected and sometimes disconnected. Indeed, this would lead to an inconsistency in the definition of the kinetic rate γ which should have a volume dependency in the former case and no volume dependency in the latter (see Section 3.4.4).

This sort of ambiguity should be resolved, if possible, by refining the ambiguous rule into cases that are either exclusively unary or binary. Each refinement having a kinetic rate that is consistent with its molecularity. Note that in practice, for models with a large number of agents, it is sufficient to assume that the rule A(x),B(y) @ γ will have only binary instances. In this case it suffices to consider the approximate model:

1assumedbinaryAB A(x),B(y) -> ... @ ga_2 
2unaryAB A(x,c!1),C(a!1,b!2),B(y,c!2) -> ... @ k_1

There are however systems where even enumerating unary cases becomes impossible or the approximation on binary instances is wrong. As an alternative, one should use the kappa notation for ambiguous rules:

which will tell KaSim to apply the above rule with a rate γ2 for binary instances and a rate k1 for unary instances. The obtained model will behave exactly as a model in which the ambiguous rule has been replaced by unambiguous refinements. However the usage of such rule slowdowns simulation in a significant manner depending on various parameters (such as the presence of large polymers in the model). We give below an example of a model utilizing binary/unary rates for rules1 .

 
1%agent: A(b,c) 
2%agent: B(a,c) 
3%agent: C(b,a) 
4## 
5%var: V 1 
6%var: k1 INF 
7%var: k2 1.0E-4/V 
8%var: k_off 0.1 
9## 
10a.b A(b),B(a) -> A(b!1),B(a!1) @ k2{k1} 
11a.c A(c),C(a) -> A(c!1),C(a!1) @ k2{k1} 
12b.c B(c),C(b) -> B(c!1),C(b!1) @ k2{k1} 
13## 
14a..b A(b!a.B) -> A(b) @ k_off 
15a..c A(c!a.C) -> A(c) @ k_off 
16b..c B(c!b.C) -> B(c) @ k_off 
17## 
18%var: n  1000 
19## 
20%init: n  A(),B(),C() 
21%mod: [E] = 10000 do $STOP "snap.dot"

Notice at lines 10-12 the use of binary/unary notation for rules. As a result binding between freely floating agents will occur at rate 'k2' while binding between agents that are part of the same complex will occur at rate 'k1'. Line 21 contains a perturbation that requires KaSim to stop the simulation after 10,000 events and output the list of molecular species present in the final mixture as a dot file (see Section 6.1) and that we give Figure 3.1.


PIC

Figure 3.1: Final mixtureobtained after 10,000 events of simulation of the poly.ka model. The infinite rate for cycle closure allows one to obtain a large number of triangles.


For rules with unary rates, one can also specify an horizon. For example in the rule

1a.b A(b),B(a) -> A(b!1),B(a!1) @ k2{k1:5}

the unary rate is applied only when the agents A and B are at an horizon 5 (or closer), of each other. Horizon is an algebraic expression but during simulation, it is always truncated to a positive integer. This feature can change in the future.


Table 3.5: Rate expressions
rate_expression ::= algebraic_expression
| algebraic_expression {algebraic_expression:algebraic_expression}

3.5 Variables

In the KF it is also possible to declare variables with the declaration:

where var_name can be any string and algebraic_expression are defined Table 3.6 (available symbols for variable, constants and operators are given Table 3.7).


Table 3.6: Algebraic expressions
algebraic_expression ::= x variable
algebraic_expression binary_op algebraic_expression
unary_op (algebraic_expression)
boolean_expression [?] algebraic_expression [:] algebraic_expression
Last item of the list is an if-expression. boolean_expression are described in Table 6.1. Think very carefully whether it is the correct think to do before using it. Mecanistic conditions have to be expressed in rule bodies not in rule rates!


Table 3.7: Symbol usable in algebraic expressions
variable Interpretation
[E] the total number of (productive) simulation events
since the beginning of the simulation
[E-] the total number of null events
[Emax] the max (productive) event limit as set by -l (in -u event mode).
Note that if unset Emax =
[T] the bio-time of the simulation
[Tsim] the cpu-time since the beginning of the simulation
[Tmax] the max (bio)-time limit as set by the option -l.
Note that if unset Tmax =
[pp] the number of requested plotting interval set by the option -p.
'v' the value of variable 'v' (declared using the %var: statement)
|t| the concentration of token t
|kappa_expression| number of occurences of the pattern kappa_expression
inf symbol for
unary/binary_op Interpretation
[f] usual mathematical functions and constants
with f {log,exp,sin,cos,tan,sqrt,pi}
[int] the floor function x x
+,-,*,/,^ basic mathematical operators (infix notation)
[mod] the modulo operator (infix notation)
[max] the maximum of two values
[min] the minimum of two values

For instance the declarations

1%var: homodimer |A(x!1),A(x!1)| 
2%var: aa homodimer/2

define 2 variables, the first one tracking the number of embeddings of A(x!1),A(x!1) in the graph over time, while the second divides this value by 2: the number of automorphisms in A(x!1),A(x!1). Note that variables that are used in the expression of another variable must be declared beforehand.

It is also possible to use algebraic expressions as kinetic rates as in

1%var: k_on 1.0E-6 # per molecule per second 
2ab A(x),A(x) -> A(x!1),A(x!1) @ k_on/2

KaSim may output values of variables in the data file (see option -p in Chapter 4) using plot do:

1%plot: var_name

One may use the shortcut:

to declare a variable and at the same time require it to be outputted in the data file.

3.6 Initial conditions

The initial mixture to which rules in the KF will be applied are declared as

or

where algebraic_expression is evaluated before initialization of the simulation (hence all token and kappa expression values in the expression are evaluated to 0). This will add to the initial state of the model mult copies of the graph described by the kappa expression. Again the DCDW convention allows us not to write the complete interface of added agents (the remaining sites will be completed according to the agent’s signature). For instance:

1%var: n 1000 
2%init: n A(),A(y~p) 
3%init: ca2+ <- 0.39 #mM

will add 1000 instances of A in its default state A(x,y~u,z~0), 1000 instances of A in state A(x,y~p,z~0) and a concentration of 0.39 mM of calcium ions. Recall that the concentration of calcium can be observed during simulation using |ca2+|. As any other declaration, %init can be used multiple times, and agents will add up to the initial state.

Chapter 4
The command line

4.1 General usage

From a terminal window, KaSim can be invoked by typing

where file_i are the input Kappa files containing the rules, initial conditions and observables (see Chapter 3). A simulation can generate several files that are described below. You should really take advantage of the option -d so that they all ends in a distinct directory.

In any case, a log called inputs.ka is generated. This is a valid kappa files such that KaSim inputs.ka reruns exactly the simulation just ran outputing the exact same outputs (using the same pseudo random numbers!). First line of this file contains an uuid that is also present in any file output during the same run.

Tables 4.1 and 4.2 summarize all the options that can be given to the simulator.

Basically, one can specify an upper bound and a plot period either in simulated or bio-time (arbitrary time unit), or in number of events. Note that bio-time is computed using Gillespie's formula for time advance (see Fig. 1.1) and should not be confused with CPU-time (it's not even proportional).

4.2 Main options

Table 4.1 summarizes the main options that are accessible through the command line. Options that expects an argument are preceded by a single dash, options that do not need any argument start with a double dash.

Two key options are the plot period -p (how often you want a line in the data file) and the limit -l of simulation. These quantities can expressed in simulated time (the default) or in number of event (using -u event).


Table 4.1: Command line: main options


Argument Description


-u unit unit of options (time/event)
-l max Terminates simulation after max 0 unit
-initial min starts the simulation at min unit (data outputs convienience only)
-p x plot a line in the data file every x unit
-o file Set the name of data file to file
Use the extension to determine format (’.tsv’, ’.svg’ or csv else)
-i file Interpret file as an input filename
(for compatibility with KaSim<= 3 and filenames starting by -)
-d dir Output any produced file to the directory dir



4.3 Advanced options

Table 4.2 summarizes the advanced options that are accessible through the command line.


Table 4.2: Command line: advanced options


Argument Description


-rescale r Multiply each initial quantity by r
--no-log Do not generate a reproductability file
-log file Specify the name of the reproductability file
(default “inputs”)
-seed n Seeds the pseudo-random number generator n > 0
-rescale r Multiply each initial quantity by r
-make-sim sim_file makes a simulation package out of the input kappa files
-load-sim sim_file use simulation package sim_file as input
--gluttony simulation mode that is memory intensive
but that speeds up simulation time
-mode batch Set non interactive mode (never halt waiting for an user
action but assume default (data loosing) answer)
-mode interactive Launch the toplevel just after model initialisation



4.4 Example

The command

will generate a file model.out containing the trajectories of the observables defined in the kappa file model.ka. A measure will be taken every 1000 events in file model.out. The command

will generate a file data.csv (default name) containing 1000 data points of a simulation of 1.5 (arbitrary) time units of the model. Note that the input Kappa file is split in four files containing, for instance, the initial conditions, init.ka, the rule set, rules.ka, the observables, obs.ka, and the perturbations, pert.ka (see Chapter 3 for details).

4.5 Interactivity

Simulations are interuptible by sending a SIGINT to the simulator. (Easiest way to send a SIGINT to a process is to press Ctrl-c in the terminal window it runs into.)

In batch mode, this stops the simulation. In other circonstances, it launches a toplevel in which you can either type

A pause condition is a boolean expression (also described in 6.1) under which the simulator will stop and fall back in the toplevel in order to allow a new interactive session.

The option -mode interactive “interrupts automaticaly the simulation” (and launches the toplevel) just after the initialization of the simulation.

Chapter 5
A simple model

We describe below the content of a simple Kappa model and give examples of some typical run1 .

5.1 ABC.ka

1#### Signatures 
2%agent: A(x,c) # Declaration of agent A 
3%agent: B(x) # Declaration of B 
4%agent: C(x1~u~p,x2~u~p) # Declaration of C with 2 modifiable sites 
5#### Rules 
6a.b A(x),B(x) -> A(x!1),B(x!1) @ on_rate #A binds B 
7a..b A(x!1),B(x!1) -> A(x),B(x) @ off_rate #AB dissociation 
8ab.c A(x!_,c),C(x1~u) -> A(x!_,c!2),C(x1~u!2)  @ on_rate #AB binds C 
9modx1 C(x1~u!1),A(c!1) -> C(x1~p),A(c)  @ mod_rate #ABC modifies x1 
10a.c A(x,c),C(x1~p,x2~u) -> A(x,c!1),C(x1~p,x2~u!1) @ on_rate #A binds C on x2 
11modx2 A(x,c!1),C(x1~p,x2~u!1) -> A(x,c),C(x1~p,x2~p) @ mod_rate #A modifies x2 
12#### Variables 
13%var: on_rate 1.0E-4 # per molecule per second 
14%var: off_rate 0.1 # per second 
15%var: mod_rate 1 # per second 
16%obs: AB |A(x!x.B)| 
17%obs: Cuu |C(x1~u,x2~u)| 
18%obs: Cpu |C(x1~p,x2~u)| 
19%obs: Cpp |C(x1~p,x2~p)| 
20#### Initial conditions 
21%init: 1000 A(),B() 
22%init: 10000 C()

Line 1-4 of this KF contains signature declarations. Agents of type C have 2 sites x1 and x2 whose internal state may be u(nphosphorylated) or p(hosphorylated). Recall that the default state of these sites is u (the first one). Line 8, rule 'ab.c' binds an A connected to someone on site x (link type !_) to a C. Note that the only rule that binds an agent to x of A is 'a.b' at line 6. Hence the use of !_ is a commodity and the rule could be replaced by

1alt_ab.c A(x!1,c),B(x!1),C(x1~u) -> ...

There are two main points to notice about this model: A can modify both sites of C once it is bound to them. However, only an A bound to a B can connect on x1 and only a free A can connect on x2. Note also that x2 is available for connection only when x1 is already modified.

5.2 Some runs

We try first a coarse simulation of 100,000 events (10 times the number of agents in the initial system).

Plotting the content of the abc.csv file one notices that nothing of significant interest happen to the observables after 250s. So we can now specify a meaningful time limit by running

which produces the data points whose rendering is given in Fig. 5.1.


PIC

Figure 5.1: Simulation of the ABC model: population of unmodified Cs (observable Cuu in red) drops rapidly and is replaced, in a first step by simply modified Cs (observable Cpu in blue) which are in turn replaced by doubly modified Cs (observable Cpp in red). Note that the population of AB complexes (observable AB in black) stabilizes slightly below 400 individuals after about 20s.


We will use this model as a running example for the next chapter, in order to illustrate various advanced concepts.

Chapter 6
Advanced concepts

6.1 Perturbation language

It is possible to trigger a perturbation of the simulation when a precondition (depending on the variables of the model) is satisfied.

By default, a perturbation is applied as soon as its precondition is satisfied and then discarded. Such perturbation is called "one shot". It is however possible to re-apply the same perturbation each time its precondition is satisfied and until a certain condition is met, using the repeat ... until constructors.

When the precondition of several perturbations are satisfied at the same time. Perturbations are triggered in the order in which they have been declared in the KF. A perturbation can only be fired once per event loop.

Basic perturbations are obtained using the declaration :

and may be applied repeatedly using:

where boolean_expression and effect_list are defined by the grammar given Table 6.1 (the operator rel can be any usual binary relation in {<,=,>} and algebraic expressions are defined Table 3.6).


Table 6.1: Perturbation expressions
perturbation_expression ::= %mod: perturbation
| %mod: repeat perturbation until boolean_expression
perturbation ::= boolean_expression do effect_list
boolean_expression ::= algebraic_expression rel algebraic_expression
| (boolean_expression || boolean_expression)
| (boolean_expression && boolean_expression)
| [not] boolean_expression
| [true] | [false]
effect_list ::= effect ; effect_list | effect
effect ::= $ADD algebraic_expression agent_expression
| $DEL algebraic_expression agent_expression
| token_name <- algebraic_expression
| $SNAPSHOT string_expression
| $STOP string_expression
| $FLUX string_expression boolean
| $TRACK 'var_name' boolean
| $UPDATE 'var_name' algebraic_expression
| $PLOTENTRY
| $PRINT string_expression <string_expression>
string_expression ::= 𝜀 | "string" . string_expression
| algebraic_expression . string_expression
boolean ::= [true] | [false]

A example of boolean expression used as a precondition is

1%mod: ([T]>10) && (v1 / v2) > 1 do ...

It indicate the wish to trigger a perturbation whenever the simulation time has passed 10 time units and the ratio of variables v1 over v2 is above 1. Recall that the perturbations are "one shot" interventions on the simulation. Possible interventions are described in the following sections using examples.

Note on time dependent preconditions:
Consider a perturbation of the form:

where f(t) is an algebraic expression dependent on time and x an arbitrary algebraic expression. Having in mind the simulation algorithm implemented by KaSim, at the beginning of an event loop, both f(t) and x will be evaluated. It is very unlikely (in general with a probability equal to 0) that both values coincide. Currently KaSim is not equipped with a solver able to detect that in the past of the current state, there was a t that made the precondition hold, unless the equation is trivial to solve. Therefore the only time dependent precondition with an equality test that is allowed in KaSim has to be of the form [T] =n with n . For instance: %mod: [T]=10 do $STOP will interrupt the simulation after exactly 10 time units.

6.1.1 Adding or deleting agents during a simulation

Continuing with the ABC model, the perturbation effect: $ADD n C(x1~p) will add n 0 instances of C with x1 already in state p (and the rest of its interface in the default state as specified line 4 of ABC.ka). Also the perturbation effect: $DEL |B(x!_)| B(x!_) will remove all Bs connected to some agent from the mixture.

There are various ways one can use perturbations to study more deeply a given kappa model. A basic illustration is the use of a simple perturbation to let a system equilibrate before starting a real simulation. For instance, as can be seen from the curve given in Fig. 5.1, the number of AB complexes is arbitrarily set to 0 in the initial state (all As are disconnected from Bs in the initial mixture). In order to avoid this, one can modify the kappa file the following way: we set the initial concentration of C to 0 by deleting line 22. Now we introduce Cs after 25 t.u using the perturbation: %mod: [T]=25 do $ADD 10000 C()

The modified kappa file is available in the source repository, in the model/ directory (file abc-pert.ka). Running again a simulation (a bit longer) by entering in the command line:

one obtains the curve given in Fig. 6.1.


PIC

Figure 6.1: Simulation of the ABC model with a perturbation: for t<25s, only 'a.b' and 'a..b' rules may apply. This enables the concentration of 'AB' complexes to go to steady state, before introducing fresh Cs at t=25s.


6.1.2 Get a snapshot of the mixture (to define a new initial state)

A snapshot is an instant photography of the current state of the mixture (a dump of the state at a given moment in the simulation).

In the previous example, we let the system evolve for some time without its main reactant C in order to let other reactants go to a less arbitrary initial state. One may object that this way of proceeding is CPU-time consuming if one has to do this at each simulation. An alternative is to use the $SNAPSHOT primitive that allows a user to export a snapshot of the mixture at a given time point as a new (piece of) kappa file. For instance, the declaration: %mod: [E-]/([E]+[E-])>0.9 do $SNAPSHOT "prefix" will ask KaSim to export the mixture the first time the percentage of null events reaches 90%. The exported file will be named prefix_n.ka where n is the event number at which the snapshot was taken. One may also use a string_expression to construct any prefix using local variables.

One may omit to define a prefix and simply type: %mod: [E-]/([E]+[E-])>0.9 do $SNAPSHOT in which case the default prefix snap.ka will be used for naming snapshots.

If the name already exists a counter will be appended at the end of the file to prevent overwriting. Snapshots can be performed multiple times, for instance every 1000 events, using the declaration:

1%mod: repeat ([E] [mod] 1000)=0 do $SNAPSHOT "abc.ka" until [false]

which results in KaSim producing a snapshot every 1000 (productive) events until the simulation ends.

Note that instead of producing kappa files, one may use snapshot perturbations to produce an image of the mixture in the dot/html format using the parameter by specifying the extention in the name skeleton (%mod: [E-]/([E]+[E-])>0.9 do $SNAPSHOT "snap.dot").

6.1.3 Interrupt simulation

The perturbation $STOP "final_state.ka" will terminate the simulation whenever its precondition is satisfied and produce a snapshot of the last mixture.

6.1.4 Changing the value of a token

The concentration of any token can be reset on the fly using a perturbation. For instance the declaration: %mod: repeat (|a|<100 do a <- |a|*2)until [false] will double the concentration of token a each time it gets below 100.

6.1.5 Causality analysis

In our ABC example, adding the instruction: %mod: [true] do $TRACK Cpp[true] will ask KaSim to turn on causality analysis for the observable 'Cpp' since the beginning of the simulation, and display the causal explanation of every new occurrence of 'Cpp', until the end of the simulation. The explanation, that we call a causal flow, is a set of rule application ordered by causality and displayed as a graph using dot format. In this graph, an edge r r' between two rule applications r and 'r' indicates that the first rule application has used, in the simulation, some sites that were modified by the application of the former. We show Fig. 6.2 an example of such causal flow.


PIC

Figure 6.2: Causal flow for the observable 'Cpp' of the ABC model. Plain arrows represent causal dependency, dotted arrows show asymmetric conflict between rule occurrences. Here the 'ab.c' rule has to occur before the 'a.b' rule. Red observable indicate that the last rule allowed one to observe a new instance of 'Cpp'.


Causality analysis of the observable Cpp can be turned off at any time using a declaration of the form: %mod: [T]>25 do $TRACK Cpp[false]

Each time KaSim detects a new occurrence of the observable that is being tracked, it will dump it’s causal past as a graph using the dot format (see Fig. 6.2 above). The name of the file in which the causal flow is stored can be set using the %def instruction (see Section 6.4).

Compressing causal flows.

In general pure causal flows will contain a lot of information that modelers may not wish to consider. Indeed in classical flows, causality (represented by an edge between to rule applications in the graph) is purely local. Therefore a sequence a b c only implies that an instance of rule a caused an instance of rule b which in turn created an instance of the observable c. However it does not imply that a was "necessary" for c to occur (for instance c might have been possible before a but not after, and b would be simply re-enabling c). It is possible to tell KaSim to retain only events that are more strongly related to the observable using two compression techniques (see Ref. [?] for formal details). Intuitively, in a weakly compressed causal flow one has the additional property that if an event e is a (possibly indirect) cause of the observable, then preventing e from occurring would have prevented the rest of the causal flow to occur (ie it is not possible to reconstruct a computation trace containing the observable with the events that remain in the causal flow). A strongly compressed causal flow enjoys the same property with an additional level of compression obtained by considering different instances of the same rule to be indistinguishable. Note that causal flow compressions may be memory and computation demanding. For large systems it may be safer to start with weak compressions only.

The type of compression can be set using the %def instruction (see Section 6.4). For instance: %def: "displayCompression" "none" "weak" "strong" will ask KaSim to output 3 versions of each computed causal flow, with all possible degrees of compressions. Each causal flow is outputted into a file [filename][Type]_n.dot where filename is the default name for causal flows which can be redefined using the parameter cflowFileName, Type is the type of compression (either nothing or Strongly, or Weakly) and n is the identifier of the causal flow. For each compression type a summary file, named [filename][Type]Summary.dat, is also produced. It allows to map each compressed causal flow to the identifier of its uncompressed version (row #id), together with the production time T and event number E at which the observable was produced. It also contains information about the size of the causal flow.

6.1.6 Flux maps


PIC

Figure 6.3: Flux map of the abc.ka model, taken from t=0 to t=20 time units. The A releasing rules a..b and mod x2 are contributing very little to the activity of a.c which is a sign of an excess of free As in the system at this time interval.


The flux map is a powerful observation that tracks, on the fly, the influence that rule applications have on each others. It is dynamically generated and tracks effective impacts (positive or negative) a every rule application. The flux map can be computed using declarations of the form:

1%mod: [true] do $FLUX "flux.dot" [true] 
2%mod: [T]>20 do $FLUX "flux.dot" [false]

The resulting flux map is a graph where a positive edge between rules r and s (in green) indicates an overall positive contribution of r over s. Said otherwise, the sum of r applications increased the activity of s. Conversely, a negative edge (in red) will indicate that r had an overall negative impact on the activity of s. Note that the importance of the flux between two rules can be observed by looking at the label on the edges that indicate the overall activity transfer (positive or negative) between the rules. The above declaration produce a flux map that is shown Fig. 6.3. Note that flux may vary during time, therefore the time or event limit of the simulation is of importance and will likely change the aspect of the produced map.

6.1.7 Updating kinetic rates on the fly

Any variable between simple quotes can be updated during a simulation using a declaration of the form: %mod: Cpp> 500 do $UPDATE k_on0.0

This perturbation will be applied whenever the observable 'Cpp' will become greater than 500. Its effect will be to set the on rate of all binding rules to 0. Note that according to the grammar given Table 6.1, one may use any algebraic expression as the new value of the variable. For instance: %mod: Cpp> 500 do $UPDATE k_onk_on/100 will cause the on rate of all rules to decrease a hunderd fold. Note that it is possible to override the kinetic rate of a specific rule: in our ABC example, the declaration: %mod: Cpp> 500 do $UPDATE a.binf will set the kinetic rate of rule 'a.b' to infinity.

6.1.8 Combining several effects in a single perturbation

As an example, consider the computation of causal flows between t = 10 and t = 20 using the declarations:

1%mod: [T]>10 do $TRACK Cpp [true] 
2%mod: [T]>20 do $TRACK Cpp [false]

The above declaration will ask KaSim to analyze each new occurrence of 'Cpp' in that time interval. If n new instances took place, then KaSim will have to compute n causal flows. One may want to bound the number of computed flows to a certain value, say 10. One may do so using the combination of perturbations and variables given below:

1%var: x 0 
2%mod: [T]>10 do ($TRACK Cpp [true] ; $UPDATE x Cpp) 
3%mod: [T]>20 || (x > 0 && Cpp - x > 9) do $TRACK Cpp [false]

The first line is a declaration of an x variable that is initially set to 0. Note that the second line is a perturbation that contains two simultaneous effects, the first one triggering causality analysis and the second one updating the value of variable x to the current value of variable 'Cpp'. The last line stops causality analysis whenever time is greater than 20 or when 10 new observables have been found (the difference between the current value of 'Cpp' and x.

6.1.9 Printing values during a simulation

The effect $PRINT string_expression <string_expression> enables one to output values during a computation to

For instance:

1%mod: repeat \ 
2|A|<0 do $PRINT "token_".[E].".dat" <"Token A is: " . |A| . " at time=". [T]>\ 
3until [false]

will ask KaSim to output the value of token A in a file "token_n.dat" which changes at each new productive event, each time its value gets below 0.

6.1.10 Add an entry in the output data

The effect $PLOTENTRY outputs a line with the current value of observables in the data file. For example, %mod: repeat [E] [mod] 10 = 0 do $PLOTENTRY until [false] will store the value of observables every 10 productive events.

6.2 Implicit signature

KaSim permits users in a hurry to avoid writing agent signatures explicitly using the option --implicit-signature of the command line. The signature is then deduced using information gathered in the KF. Note that it is not recommended to use the DCDW convention for introduced agents in conjunction with the --implicit-signature option unless the default state of all sites is mentioned in the %init declarations or in the rules that create agents.

6.3 Simulation packages

The simulation algorithm that is implemented in KaSim requires an initialization phase whose complexity is proportional to R G where R is the cardinal of the rule set and G the size of the initial mixture. Thus for large systems, initialization may take a while. Whenever a user wishes to run several simulations of the same kappa model, it is possible to skip this initialization phase by creating a simulation package. For instance:

will generate a standard simulation of the abc.ka model, but in addition, will create the simulation package abc.kasim (.kasim extension is not mandatory). This package is a binary file, ie not human readable, that can be used as input of a new simulation using the command:

Note that this simulation is now run for k time units instead of n. Importantly, simulation packages can only be given as input to the same KaSim that produced it. As a consequence, recompiling the code, or obtaining different binaries, will cause the simulation package to become useless.

6.4 Simulation parameters configuration

In the KF (usually in a dedicated file) one may use expressions of the form:

%def: "parameter_name" "parameter_value"

where tunable parameters are described table 6.2 (default values are given first in the possible values column).


Table 6.2: User defined parameters
parameter possible values description



Simulation
"maxConsecutiveClash" "2" or any integer number of consecutive clashes
before giving up
square approximation
"T0" float simulation starting time
(outputs convienience only)
"seed" any positive integer pseudo-random number
generator seed



Outputs
"traceFileName" string outputs simulation trace
in the given file
"outputFileName" string data file name
"plotPeriod" number then optionally interval between
"events" plot lines
Causality analysis Deprecated Please use KaStor
"displayCompression" any combination of type of compression
"none", "strong", "weak"
"cflowFileName" "cflow", any string file name prefix for causal flows
"dotCflows" "no", "html" generate causal flows in html
"yes", "dot" generate causal flows in dot
"json" generate causal flows in json



Pretty printing
"dumpIfDeadlocked" "no","yes" Snapshot when simulation
is stalled
"colorDot" "no", "yes" use colors in dot format files
"progressBarSymbol" "#" or any character symbol for the progress bar
"progressBarSize" "60" or any integer length of the progress bar

Chapter 7
The KaSa static analyser

7.1 General usage

From a terminal window, KaSa can be invoked by typing

where file_i are the input Kappa files containing the rules, initial conditions and observables (see Chapter 3).

All the options are summarised as follows:

General options  
  --help            Verbose help  
   -h               Short help  
  --version         Show version number  
  --gui             GUI to select  
  --(no-)expert     Expert mode (more options)  
 
Actions  
  --do-all  
      launch everything  
  --reset-all  
      launch nothing  
  --(no-)compute-contact-map    (default: enabled)  
      compute the contact map  
  --(no-)compute-influence-map    (default: enabled)  
      compute the influence map  
  --(no-)compute-ODE-flow-of-information    (default: disabled)  
      Compute an approximation of the flow of information in the ODE  
      semantics  
  --(no-)compute-stochastic-flow-of-information    (default: disabled)  
      Compute an approximation of the flow of information in the stochastic  
      semantics  
  --(no-)compute-reachability-analysis    (default: enabled)  
      Compute an approximation of the states of agent sites  
  --(no-)compute-symmetries    (default: disabled)  
      Look up for pairs of symmetric sites  
  --(no-)compute-local-traces    (default: disabled)  
      Compute the local traces of interesting parts of agent interfaces  
  --(no-)compute-separating-transitions    (default: disabled)  
      Compute the transitions that separates strongly connected set of  
      configurations  
 
Output  
  --output-directory <value>  
      Default repository for outputs  
  --output-contact-map-directory <name>   (default: output)  
      put the contact map file in this directory  
  --output-contact-map <name>   (default: contact)  
      file name for the contact map output  
  --output-influence-map-directory <name>   (default: output)  
      put the influence map file in this directory  
  --output-influence-map <name>   (default: influence)  
      file name for the influence map  
  --influence-map-format DOT | DIM | HTML  
 (default: DOT)  
      Tune the output format for the influence map  
  --output-local-traces-directory <name>   (default: output)  
      put the files about local traces in this directory  
  --local-traces-format DOT | HTML  
 (default: DOT)  
      Tune the output format for the local transition systems  
  --output-log-directory <name>   (default: output)  
      put the log files in this directory  
 
Reachability analysis  
  --(no-)compute-reachability-analysis    (default: enabled)  
      Compute an approximation of the states of agent sites  
  --enable-every-domain  
      enable every abstract domain  
  --disable-every-domain  
      disable every abstract domain  
  --contact-map-domain static | dynamic  
 (default: dynamic)  
      contact map domain is used to over-approximate side-effects  
  --(no-)views-domain    (default: enabled)  
      enable local views analysis  
  --(no-)double-bonds-domain    (default: enabled)  
      enable double bonds analysis  
  --(no-)sites-across-bonds-domain    (default: enabled)  
      enable the analysis of the relation among the states of sites in  
      connected agents  
  --verbosity-level-for-reachability-analysis Mute | Low | Medium | High |  
                                              Full  
 (default: Low)  
      Tune the verbosity level for the reachability analysis  
  --output-mode-for-reachability-analysis raw | kappa | english  
 (default: kappa)  
      post-process relation and output the result in the chosen format  
 
Trace analysis  
  --(no-)compute-local-traces    (default: disabled)  
      Compute the local traces of interesting parts of agent interfaces  
  --(no-)show-rule-names-in-local-traces    (default: enabled)  
      Annotate each transition with the name of the rules in trace  
      abstraction  
  --(no-)use-macrotransitions-in-local-traces    (default: disabled)  
      Use macrotransitions to get a compact trace up to change of the  
      interleaving order of commuting microtransitions  
  --(no-)ignore-trivial-losanges    (default: disabled)  
      Do not use macrotransitions for simplifying trivial losanges  
  --(no-)compute-separating-transitions    (default: disabled)  
      Compute the transitions that separates strongly connected set of  
      configurations  
  --output-local-traces-directory <name>   (default: output)  
      put the files about local traces in this directory  
  --local-traces-format DOT | HTML  
 (default: DOT)  
      Tune the output format for the local transition systems  
 
Contact map  
  --(no-)compute-contact-map    (default: enabled)  
      compute the contact map  
  --output-contact-map-directory <name>   (default: output)  
      put the contact map file in this directory  
  --output-contact-map <name>   (default: contact)  
      file name for the contact map output  
  --contact-map-accuracy-level Low | High  
 (default: Low)  
      Tune the accuracy level of the contact map  
  --(no-)pure-contact    (default: disabled)  
      show in the contact map only the sites with a binding state  
 
Influence map  
  --(no-)compute-influence-map    (default: enabled)  
      compute the influence map  
  --influence-map-accuracy-level Indirect | Direct | Realisable  
 (default: Direct)  
      Tune the accuracy level of the influence map  
  --output-influence-map-directory <name>   (default: output)  
      put the influence map file in this directory  
  --output-influence-map <name>   (default: influence)  
      file name for the influence map  
  --influence-map-format DOT | DIM | HTML  
 (default: DOT)  
      Tune the output format for the influence map  
 
Flow of information  
  --(no-)compute-ODE-flow-of-information    (default: disabled)  
      Compute an approximation of the flow of information in the ODE  
      semantics  
  --(no-)compute-stochastic-flow-of-information    (default: disabled)  
      Compute an approximation of the flow of information in the stochastic  
      semantics  
 
Debugging information  
  --output-log-directory <name>   (default: output)  
      put the log files in this directory  
  --(no-)debug    (default: disabled)  
      dump debugging information  
  --(no-)unsafe-mode    (default: enabled)  
      exceptions are gathered at the end of the computation, instead of  
      halting it  
  --(no-)print-efficiency    (default: disabled)  
      prompt CPU time and various datas  
 
(57 options)

Orders in option matter, since they can be used to toggle on/off some functionalities or to assign a value to some environment variables. The options are interpreted from left to right.

More options are available in the OCaml file KaSa_rep/config/config.ml and can be tuned before compilation.

7.2 Graphical interface

7.2.1 Launching the interface

The graphical interface can be launched by typing

without any option.


PIC

Figure 7.1: KaSa  graphical interface - sub-tab Actions


7.2.2 The areas of interests

There are five different areas of importance in the graphical interface:

  1. On the top left of the window, a button allows for the selection between the Normal and the Expert mode (other modes may be available if activated at compilation). In expert modes, more options are available in the graphical interface.
  2. On the top center/right, some button allows for the selection of the tab. There are currently six sub-tabs available: Actions, Output, Reachability analysis, Trace analysis, Contact map, Influence map.
  3. Center: The options of the selected sub-tab are displayed and can be tuned.

    Contextual help is provided when the mouse is hovered over an element.

    The interface will store the options that are checked or filled and the order in which they have been selected. When launched, the analysis interprets these options in the order they have been entered.

    Some options appear in several sub-tabs. They denote the same option and share the same value.

  4. File selector: The file selector can be used to upload as many kappa files as desired. The button ’Clear’ can be used to reset the selection of files.
  5. Bottom: Some buttons are available. The button ’Quit’ can be used to leave the interface. The button ’Reset to default’ tune all the options to their default value. The button ’Import options’ can be used to restore the value of the options as saved during a previous session of the graphical interfaces. The button ’Save options’ can be used to save the value of the options for a further session. The button ’Launch analyze’ launch KaSa with the current options.

    Importantly, options are saved automatically under various occasions. Thus, it is possible to restore the value of the options before the last reset, before the last quit, or before the last analysis.

7.2.3 The sub-tab Actions

The sub-tab Actions (see Fig. 7.1) contains the main actions which can be performed.

7.2.4 The sub-tab Output


PIC

Figure 7.2: KaSa  graphical interface - sub-tab output


The sub-tab Ouput (see Fig. 7.2) contains the names of the output files and their format.

When a file already exists, it is overwritten without any warning.

7.3 Reachability analysis


PIC

Figure 7.3: KaSa  graphical interface - sub-tab Reachability_analysis


Reachability analysis aimed at detecting statically properties about the bio-molecular species that can be formed in a model. Knowing whether, or not, a given bio-molecular species, can be formed in a model is an undecidable problem [?]. Thus, our analysis is approximate. Indeed, it computes an over-approximation of the set of the bio-molecular species that can be reached from the initial state of the model, by applying an unbounded number of computation steps. As formalized in [??], the abstraction consists in:

  1. firstly, ignoring the number of occurrences of bio-molecular species (we assume that whenever a bio-molecular species can be formed, then it can be formed as many time as it could be necessary),
  2. secondly, abstracting a bio-molecular species by the set of its properties.

The analysis takes into account also the chemical species that may be introduced in a perturbation.

The classes of properties of interest are encoded in so called abstract domains, which can be independently enabled/disabled. The whole analysis can be understood as a mutual recursion between smaller analyses (one per abstract domain), that communicates information between each other at each step of the analysis. We took the same scheme of collaboration between abstract domains as in [?].

As an example, we consider the following model:

1%agent: E(x) 
2%agent: R(x,c,cr,n) 
3 
4%init: 1 E() 
5%init: 1 R() 
6 
7E.R E(x),R(x) -> E(x!1),R(x!1) @1 
8E/R E(x!1),R(x!1,c) -> E(x),R(x,c) @1 
9R.R R(x!_,c),R(x!_,c) -> R(x!_,c!1),R(x!_,c!1) @1 
10R/R R(c!1,cr,n),R(c!1,cr,n) -> R(c,cr,n),R(c,cr,n) @1 
11R.int R(c!1,cr,n),R(c!1,cr,n) -> R(c!1,cr!2,n),R(c!1,cr,n!2) @1 
12R/int R(cr!1),R(n!1) -> R(cr),R(n) @1 
13obs R(x,c,cr!_,n!_) -> R(x,c,cr,n) @1

Typing the following instruction:

KaSa reachability.ka --reset-all --compute-reachability-analysis

will perform the reachability analysis on the model reachability.ka.

We obtain the following result:

Kappa Static Analyzer (14d1fe2) (without Tk interface)  
Analysis launched at 2017/05/27 06:54:48 (GMT+0) on  
testing-gce-b12e09ba-2d97-42af-9435-91a073624230  
Parsing ../kappa/reachability.ka...  
done  
Compiling...  
Reachability analysis...  
 
------------------------------------------------------------  
* There are some non applyable rules  
------------------------------------------------------------  
rule obs (File "../kappa/reachability.ka", line 13,  
characters 5-39:) will never be applied.  
------------------------------------------------------------  
every agent may occur in the model  
 
------------------------------------------------------------  
* Non relational properties:  
------------------------------------------------------------  
E() => [ E(x) v E(x!R.x) ]  
R() => [ R(c) v R(c!R.c) ]  
R() => [ R(n) v R(n!R.cr) ]  
R() => [ R(cr) v R(cr!R.n) ]  
R() => [ R(x) v R(x!E.x) ]  
 
------------------------------------------------------------  
* Relational properties:  
------------------------------------------------------------  
R() =>  
   [  
  R(c,cr,n,x!E.x)  
v R(c!R.c,cr!R.n,n,x!E.x)  
v R(c!R.c,cr,n,x!E.x)  
v R(c!R.c,cr,n!R.cr,x!E.x)  
v R(c,cr,n,x)  
   ]  
------------------------------------------------------------  
* Properties in connected agents  
------------------------------------------------------------  
R(c!1),R(c!1) =>  
[  
  R(c!1,cr!R.n),R(c!1,cr)  
v R(c!1,cr),R(c!1,cr)  
v R(c!1,cr),R(c!1,cr!R.n)  
]  
R(c!1),R(c!1) =>  
[  
  R(c!1,n!R.cr),R(c!1,n)  
v R(c!1,n),R(c!1,n)  
v R(c!1,n),R(c!1,n!R.cr)  
]  
------------------------------------------------------------  
* Properties of pairs of bonds  
------------------------------------------------------------  
R(c!R.c,cr!R.n) => R(c!1,cr!2),R(c!1,n!2)  
R(c!R.c,n!R.cr) => R(c!1,n!2),R(c!1,cr!2)  
execution finished without any exception

This result is displayed in the standard output, and it is made of six parts.

The first two parts provide an enumeration of dead rules and dead agents. The next parts display what we call refinement lemmas. A refinement lemma is made of a precondition (on the left of the implication symbol) that is a site graph, and a postcondition (on the right of the implication symbol) that is a list of site graphs. Each site graph in the post-condition is a refinement of the precondition (the position of agent matters: the n-th agent in the precondition corresponds to the n-th agent in each site graph in the postcondition, but site graphs in a postcondition may have more agents than the site graph in the corresponding precondition). The meaning of a refinement lemma is that every embedding between its precondition into a reachable state can be refined/extended into an embedding from one site graph in its postcondition into the same reachable state. This way, a refinement lemma provides an enumeration of all the potential contexts for the precondition.

We now detail the six different parts:


Kappa Static Analyzer (14d1fe2) (without Tk interface)  
Analysis launched at 2017/05/27 06:54:48 (GMT+0) on  
testing-gce-b12e09ba-2d97-42af-9435-91a073624230  
Parsing ../kappa/reachability.ka...  
done  
Compiling...  
Reachability analysis...  
execution finished without any exception


Figure 7.4: Reachability analysis of the model reachbility.ka with verbosity level “Mute”.



Applying rule obs (File "../kappa/reachability.ka", line 13, characters  
5-39:):  
the precondition is not satisfied yet


Figure 7.5: Reachability analysis: one rule that cannot be applied yet, according to the bio-molecular species already constructed.



Applying rule E.R (File "../kappa/reachability.ka", line 7, characters  
5-35:):  
the precondition is satisfied


Figure 7.6: Reachability analysis: one rule successfully applied



Views in initial state:  
 
E(x!free)  
--  
Views in initial state:  
 
R(x!free,c!free,cr!free,n!free)


Figure 7.7: Reachability analysis: extensional description of initial states.



Applying rule E.R (File "../kappa/reachability.ka", line 7, characters  
5-35:):  
the precondition is satisfied  
 
rule E.R (File "../kappa/reachability.ka", line 7, characters  
5-35:) is applied for the first time  
 
Updating the views for E(x!)  
 
E(x!R@x)  
 
 
Updating the views for R(x!,c!,cr!,n!)  
 
R(x!E@x,c!free,cr!free,n!free)  


Figure 7.8: Reachability analysis: extensional description of the new patterns created when applying a rule.



Applying rule E.R (File "../kappa/reachability.ka", line 7, characters  
5-35:):  
the precondition is satisfied  
 
rule E.R (File "../kappa/reachability.ka", line 7, characters  
5-35:) is applied for the first time  
(rule E/R (File "../kappa/reachability.ka", line  
8, characters 5-39:)) should be investigated  
 
(rule E/R (File "../kappa/reachability.ka", line  
8, characters 5-39:)) should be investigated  
 
 
Updating the views for E(x!)  
 
E(x!R@x)  
 
 
Updating the views for R(x!,c!,cr!,n!)  
 
R(x!E@x,c!free,cr!free,n!free)  
 
(rule E.R (File "../kappa/reachability.ka", line 7,  
characters 5-35:)) should be investigated  


Figure 7.9: Reachability analysis: discovering new patterns force the analysis to apply some rules again, until reaching a fix-point.


Now we describe the options that are available on this sub-tab.

The option --compute-reachability-analysis can be used to switch on/off then reachability analysis.

The option --enable-every-domain can be used to switch on every abstract domain, whereas the option --disable-every-domain can be used to switch off every abstract domain.

The option --contact-map-domain impacts the way side-effects are handled with during the analysis. In static mode, we consider that every bond that occurs syntactically in initial state, in the rhs of a rule, or in a introduction directive of a perturbation, may be released by side-effects. In dynamic mode, only the bond that has been encountered so far during the analysis are considered.

The option --views-domain can be used to switch on/off the views domains that combine the non-relational analysis and the relational analysis.

The option --double-bonds-domain can be used to switch on/off the analysis of potential double bonds between between proteins.

The option --site-across-bonds-domain can be used to switch on/off the analysis of the relations among the states of the sites in connected proteins.

It is possible to get more details about the computation of the analysis by tuning the verbosity level of the view analysis:

The option --output-mode-for-reachability-analysis can be used to tune the output of the analysis. The default mode is kappa. In mode, raw, patterns of interest are displayed extensionally. In mode, english, properties of interest are explained in English. The option --use-natural-language can be used to switch on/off the translation of properties in natural language: when the option is disabled, each relationship is described in extension.

7.4 Local traces


PIC

Figure 7.10: KaSa  graphical interface - sub-tab Trace analysis


Trace analysis is a refinement of reachability analysis that additionaly explains how one agent can go from a given view to another one, following a path that we call a local trace. Thus the set of the local traces for a given agent can be described as a transition system among the views for a given agent: in this transition system, the nodes are local views; introduction arrows correspond to either initial states, or creation rules; transitions denote a potential conformation change of an agent, from one local views to another one, due to the application of a given rule.

We consider the following example:

1  %init: 1 P() 
2  %init: 1 K() 
3 
4  a1+ P(a1~u) -> P(a1~p) @1 
5  b1+ P(a1~p,b1~u) -> P(a1~p,b1~p) @1 
6  a1- P(a1~p,b1~u) -> P(a1~u,b1~u) @1 
7  b1- P(b1~p,g) -> P(b1~u,g) @1 
8  a2+ P(tab:siga2~u) -> P(a2~p) @1 
9  a2- P(a2~p,g) -> P(a2~u,g) @1 
10  b2+ P(a2~p,b2~u) -> P(a2~p,b2~p) @1 
11  b2- P(b2~p,g) -> P(b2~u,g) @1 
12  P.K P(a1~p,a2~p,b1~p,b2~p,g),K(x) -> P(a1~p,a2~p,b1~p,b2~p,g!1),K(x!1) @1 
13  P/K P(a1~p,a2~p,b1~p,b2~p,g!1),K(x!1) -> P(a1~p,a2~p,b1~p,b2~p,g),K(x) @1

Typing the following instruction:

KaSa protein2x2.ka --reset-all --compute-local-traces

will perform the trace analysis on the model protein2x2ka, and produce two dot format files Agent_trace_K_x^.dot and Agent_trace.P.a1_.a2_.b1_.b2_.g^.dot. The output repository can be changed thanks to the command line options –output-directory and –output-local-trace-directory. Moreover, file names is made of the prefix Agent_trace, followed by the kind of protein and the list of the sites of interest (the symbol ‘^’ denotes a binding state, and the symbol ‘_’ an internal state).

The transition system that describes the local traces for the agents of kind P is descrided in Figure 7.11. We notice that the nodes of this transition system are labelled with the states of the sites of P. The internal state of a site x is denoted as xu (meaning that the site x has state u, whereas the binding state of a site x is denoted as x!free, when the site is free, and as x!K@x when the site x is bound to the site x of a given agent of kind K.


PIC

Figure 7.11: Local traces for the protein2x2.ka model defined in Section 7.4


We notice that the transition system that is given in Fig. 7.11 contains too many nodes. We can coarse-grain this transition system thanks to the following option:

–use-macrotransitions-in-local-traces.

Typing the following instruction:

KaSa protein2x2.ka --reset-all --compute-local-traces  
                   --use-macrotransitions-in-local-traces

will perform the trace analysis on the model protein2x2ka, and produce two dot format files Agent_trace_K_x^.dot and Agent_trace.P.a1_.a2_.b1_.b2_.g^.dot. The name of the output repository can be changed thanks to the command line options –output-directory and –output-local-trace-directory. This time, the files describe a coarse-graining of the corresponding transition systems.

For instance, the coarse-grained transition system for the local traces of the proteins of kind P, is given in Figure 7.12. This coarse-grained transition system is a compact implicit encoding of the transition system in Figure 7.11. It is obtained by exploiting the fact that locally, the behavior of the pair of states a1 and b1 is independent from the behavior of the pair of states a2 and b2, until these four sites are phosphorylated, so that the site g can get bound.

More formally, in that transition system, some states are microstates (in a microstate, the state of each site is documented); some others are macrostates: (in a macrostate, the states of only a subset of site is documented). Thus a macrostate v can be seen intensionally as a part of a local view, but also extensionnaly as the set γ(v) of the local views they are a subpart of. A microstate v can be described by any sequence (vi) of macrostates prodiding that the intersection γ(vi) of the extensional denotation γ(vi) of these macrostates vi, is equal to the singleton {v}; moreover a transition between two microstates v and v can be described by any transition between one macro state v and another one v, provided that there exists a sequence of macrostate (vi) such that the sequence (v,(vi)) denotes the microstate v and the sequence (v,(vi)) denotes the microstate v.


PIC

Figure 7.12: Local traces for the protein2x2.ka model defined in Section 7.4


Such coarse-grained transition system can be geometrically interpreted as a simplicial complex [?].

As a microstate could be decomposed into several sequences of macrostates (including the trivial sequence containing only the microstate itself), the system may jump spontaneously (by using a 𝜀 transition) from one representation to another representation. This corresponds to the intersection between several simplexes in the corresponding simplificial complex.

Although the semantics of a coarse-grainged transition system is fully defined by its labelled transitions, it is useful to annotate the graph by some information about the relation between the denotation of each macrostate. By default, we use hypertlinks to relate each macrostate v (including each microstate) to the set of its immediate subparts v. In such a hyperlink, v is connected via a dotted arrow, whereas each immediate subpart is connected via a dashed arrow.

More options are available in expert mode, but they are not documented yet.

7.5 Contact map


PIC

Figure 7.13: KaSa  graphical interface - sub-tab Contact map


The contact map of a model is an object that may help modelers checking the consistency of the rule set they use. The contact map is statically computed and does not depend on kinetic rates nor initial conditions.

Typing the following instruction:

KaSa abc.ka –reset-all –compute-contact-map

will produce a dot format file named contact.dot. The name of the output file and the directory can be changed thanks to the command line options –output-contact-map and –output-directory. The directory is assumed to exist. The file will be overwritten if it exists. All the options related to the computation of the contact map can be accessed on the sub-tab Contact map of the graphical interface (see Fig. 7.15).

The contact map summarises the different types of agent, their interface and the potential binding between sites. It is an over approximation, thus if the contact map indicates a potential bond, it does not mean that it is always possible to reach a state in which two sites of these kinds are bound, but if the contact map indicates no bond between two sites, it means that it is NOT possible to reach a state in which two sites of these kinds are bound together.

The contact map for the abc.ka model defined in Chapter 5 is given in Figure 7.14. On this map, we notice that there are three kinds of agent, namely A, B, and C. Agents of kind A have two sites x and c, that bear no internal state (they appear in yellow only), agents of kind B have one site x, that bears no internal state (they appear in yellow only), and agents of kind C have two sites x1 and x2 with both a binding state and an internal state (they appear both in yellow and in green). We notice that when a site can bear both an internal state and a binding state, they are considered as two different sites in the contact map. Additionally, the contact map indicates that sites x of the agents of kind A can be bound to the site x of an agent of kind B and that sites c of the agents of kind A can be bound to the agents of kind C either on the site x1, or on the site x2.


PIC

Figure 7.14: Contact Map for the abc.ka model defined in Chapter 5


7.6 Influence map

The influence map of a model is an object that may help modelers checking the consistency of the rule set they use.

Typing the following instruction:

KaSa abc.ka –reset-all –compute-influence-map

will produce a dot format file named influence.dot. The name of the output file and the directory can be changed thanks to the command line options –output-influence-map and –output-directory. The directory is assumed to exist. The file will be overwritten if it exists. All the options related to the computation of the influence map can be accessed on the sub-tab Influence map of the graphical interface (see Fig. 7.15). Two formats are available for the output: influence map can be generated in DOT or HTML format. The format can be choosen thanks to the command line option –influence-map-format.


PIC

Figure 7.15: KaSa  graphical interface - sub-tab Influence map


Unlike the flux map, the influence map is statically computed and does not depend on kinetic rates nor the quantities in initial conditions. It describes how rules may potentially influence each other during a simulation. KaSa will produce a dot format file containing the influence relation over all rules and observables of the model. The produced graph visualised using a circular rendering1 is given in Figure 7.16. Observables are represented as circular nodes and rules as rectangular nodes. The labels of the nodes are either the label of the rule or of the observable (if available), otherwise it is made of a unique identifier allocated by KaSa followed by the kappa definition of the rule/observable. Edges are decorated with the list of embeddings (separated by a semi-colon) allowing the identification of agents in both rules's right hand sides/left hand sides. More precisely, for positive influences, the notation [i j] denotes a pair of embeddings from the agent number i of the origin's right hand side and from the agent number j of the target's left hand side and the notation [i j] denotes a pair of embeddings from an agent attached to the agent number i of the origin's left hand side, which have been freed by side effect and from the agent number j of the target's left hand side; for negative influences, the notation [i j] denotes a pair of embeddings from the agent number i of the origin's left hand side and from the agent number j of the target's left hand side and the notation [i j] denotes a pair of embeddings from an agent attached to the agent number i of the origin's left hand side, which have been freed by side effect and from the agent number j of the target's left hand side; Observables have no influence, but they can be influenced by rules, if the rule can increase or decrease their value.


PIC

Figure 7.16: The influence map of the abc.ka model defined in Chapter 5. Edge labels denote embeddings with the convention that the notation [i j], in a positive influence, denotes a pair of embeddings from the agent number i of the origin's right hand side and from the agent number j of the target's left hand side; the notation [i j], in negative influence, denotes a pair of embeddings from the agent number i of the origin's left hand side and from the agent number j of the target's left hand side; the notation [i j], whatever the influence is positive of negative, denotes a pair of embeddings from an agent attached to the agent number i of the origin's left hand side, which have been freed by side effect and from the agent number j of the target's left hand side.


More formally, consider the rules r : L R and s : L R. One wishes to know whether it is possible that the application of rule r over a graph G creates a new instance of rule s (which is called a positive influence and that is described by green arrows in the influence map), or destroy a previous instance of rule s (which is called negative influence and that is described by red arrows in the influence map). In Fig. 7.17, we illustrate the construction of positive influences due to overlap of the left hand side of a rule and the right hand side of another rule on some sites that are modified by the former one.


PIC

Figure 7.17: Computation of the influence of the top rule on the rule below: the right hand side of the first rules embeds in a common term with the left hand side of the second rule. It results that the first rule has a positive influence on the second.


The current implementation has the following limitations:

Lastly, KaSa computes an over-approximation of the influence map. They may show an influence despite the fact that there can be no actual one. But if it shows no influence it means that either there are NO such influence, or that we are in a case that is not covered yet as itemised previously.

Three levels of precision are available: Low, Medium, and High. The level of precision can be changed thanks to the command line option –influence-map-accuracy-level.

At low precision, an influence is detected if one rule change at least one bit of information (the internal state of a site, the binding state of a site), in favor/defavor of the application another rule. This abstraction level ignore completely the context of application of rules, and just focuses on modifications.

At medium precision, the analysis checks that both rules have a common context.

At high precision, the analysis checks that such common context is realizable taking into account the species that have been declared as initial states and the potential species introduction in perturbations. High resolution influence is parameterized by the accuracy of the reachability analysis. It may happen that a given context is infeasible, but that this is not detected by the analysis.

Let us illustrate these three levels of accuracy by a case study.

We consider the following model.

1  %agent: A(w~u~p,x~u~p,y~u~p,z~u~p) 
2 
3  A(x~u) -> A(x~p) @1 
4  A(x~p,y~u) -> A(x~p,y~p) @1 
5  A(y~p,z~u) -> A(y~p,z~p) @1 
6  A(x~u,z~p,w~u) -> A(x~u,z~p,w~p) @1 
7  A(x~u,z~u) -> A(x~u,z~p) @1 
8  A(x~p,w~p) -> A(x~p,w~u) @1 
9 
10  %init: 10 A()

The low resolution influence map is given in Fig. 7.18. There is a positive arc (in green) from a rule to another one whenever the application of the former pushes at least one bit of information towards the application of the later; whereas there is a negative arc (in red) from a rule to another one whenever the former pulls at least one bit of information away from the application of the later.

The medium resolution influence map is given in Fig. 7.19. Every arc corresponding to incompatible contexts have been removed. In our example, these are the arcs from the rule 3 and the rule 5 (in both direction). Despite the fact that the rule 3 may phosphorylate the site w which is required to apply the rule 5, no instance of the rule 5 may be applied thanks to the application of the rule 3 right after, because after the application of the rule 3 the state of the site x is necessarily unphosphorylated, whereas it has to be phosphorylated for the rule 5 to be applied. The same kind of explanation holds to remove the arc from the rule 5 to the rule 3.

There are some structural invariants in these models. We give in Fig. 7.21 the log of the computation of the high resolution contact map. It turns out that whenever the site y of an agent is phosphorylated, then the site x of this protein is phosphorylated as well. Thus we can deduce that the positive arc from the rules 2 and 3, and the negative arcs from the rules 2 and 4 (in both direction) are false positive unless we change the set of the species in the initial state or in the perturbations. Thus we obtain the high resolution influence map given in Fig. 7.20.


PIC

Figure 7.18: Low resolution influence map



PIC

Figure 7.19: Medium resolution influence map



PIC

Figure 7.20: High resolution influence map



Kappa Static Analyzer (14d1fe2) (without Tk interface)  
Analysis launched at 2017/05/27 06:54:47 (GMT+0) on  
testing-gce-b12e09ba-2d97-42af-9435-91a073624230  
Parsing ../kappa/influence.ka...  
done  
Compiling...  
Reachability analysis...  
------------------------------------------------------------  
every rule may be applied  
------------------------------------------------------------  
every agent may occur in the model  
 
------------------------------------------------------------  
* Non relational properties:  
------------------------------------------------------------  
A() => [ A(x~u) v A(x~p) ]  
A() => [ A(w~u) v A(w~p) ]  
A() => [ A(y~u) v A(y~p) ]  
A() => [ A(z~u) v A(z~p) ]  
 
------------------------------------------------------------  
* Relational properties:  
------------------------------------------------------------  
A(w~p) => A(w~p,z~p)  
A(y~p) => A(x~p,y~p)  
------------------------------------------------------------  
* Properties in connected agents  
------------------------------------------------------------  
------------------------------------------------------------  
* Properties of pairs of bonds  
------------------------------------------------------------  
execution finished without any exception


Figure 7.21: Log of the reachability analysis.


Chapter 8
The KaDE ODEs generator

8.1 General usage

From a terminal window, KaDE can be invoked by typing

where file_i are the input Kappa files containing the rules, initial conditions and observables (see Chapter 3).

All the options are summarised as follows:

General options  
  --help            Verbose help  
   -h               Short help  
  --version         Show version number  
  --gui             GUI to select  
  --(no-)expert     Expert mode (more options)  
 
Data set  
  -(no-)initial <float>   (default: 0.000000)  
      Min time of simulation (arbitrary time unit)  
  -(no-)l <float>   (default: 1.000000)  
      Limit of the simulation  
  -(no-)p <float>   (default: 0.010000)  
      plot period: time interval between points in plot (default: 1.0)  
  -d <name>   (default: .)  
      Specifies directory name where output file(s) should be stored  
  --output <value>  
      Prefix for file name output  
 
Output  
  --(no-)output-plot <name>   (default data.csv)  
      file name for data output  
  --ode-backend dotnet | maple | mathematica | matlab | octave | sbml  
 (default: octave)  
      Select the backend format  
  -mode batch | interactive  
 (default: interactive)  
      either "batch" to never ask anything to the user or "interactive" to  
      ask something before doing anything  
  --(no-)constant-propagation    (default: disabled)  
      propagate constants  
  --(no-)show-reactions    (default: enabled)  
      Annotate ODEs by the corresponding chemical reactions  
  --(no-)smash-reactions    (default: disabled)  
      Gather identical reactions in the ODEs  
  -d <name>   (default: .)  
      Specifies directory name where output file(s) should be stored  
  --output <value>  
      Prefix for file name output  
 
Semantics  
  --(no-)output-plot <name>   (default data.csv)  
      file name for data output  
  --rate-convention KaSim | Divide_by_nbr_of_autos_in_lhs | Biochemist  
 (default: Divide_by_nbr_of_autos_in_lhs)  
      convention for dividing constant rates  
  --count Embeddings | Occurrences  
 (default: Embeddings)  
      tune whether we cound in embeddings or in occurrences  
  --(no-)truncate <int>   (default: disabled)  
      truncate the network by discarding species with size greater than the  
      argument  
  --with-symmetries None | Backward | Forward  
 (default: None)  
      Tune which kind of bisimulation is used to reduce the set of species  
  -d <name>   (default: .)  
      Specifies directory name where output file(s) should be stored  
  --output <value>  
      Prefix for file name output  
 
Integration settings  
  -(no-)initial <float>   (default: 0.000000)  
      Min time of simulation (arbitrary time unit)  
  -(no-)l <float>   (default: 1.000000)  
      Limit of the simulation  
  --(no-)output-plot <name>   (default data.csv)  
      file name for data output  
  --(no-)smash-reactions    (default: disabled)  
      Gather identical reactions in the ODEs  
  -(no-)p <float>   (default: 0.010000)  
      plot period: time interval between points in plot (default: 1.0)  
  --(no-)compute-jacobian    (default: enabled)  
      Enable/disable the computation of the Jacobian of the ODEs  
 (not  
      available yet)  
  --(no-)nonnegative    (default: disabled)  
      Enable/disable the correction of negative concentrations in stiff ODE  
      systems  
  --initial-step <float>   (default 0.000010)  
      Initial integration step  
  --max-step <float>   (default 0.020000)  
      Maximum integration step  
  --relative-tolerance <float>   (default 0.001000)  
      tolerance to relative rounding errors  
  --absolute-tolerance <float>   (default 0.001000)  
      tolerance to absolute rounding errors  
  -d <name>   (default: .)  
      Specifies directory name where output file(s) should be stored  
  --output <value>  
      Prefix for file name output  
 
Model reduction  
  --with-symmetries None | Backward | Forward  
 (default: None)  
      Tune which kind of bisimulation is used to reduce the set of species  
  --(no-)show-symmetries    (default: disabled)  
      Display the equivalence relations over the sites  
  -d <name>   (default: .)  
      Specifies directory name where output file(s) should be stored  
  --output <value>  
      Prefix for file name output  
 
Static analysis  
  --(no-)views-domain    (default: enabled)  
      Enable/disable views analysis when detecting symmetric sites  
  --(no-)double-bonds-domain    (default: enabled)  
      Enable/disable double bonds analysis when detecting symmetric sites  
  --(no-)site-across-bonds-domain    (default: enabled)  
      Enable/disable the analysis of the relation amond the states of sites  
      in  
 connected agents  
  -d <name>   (default: .)  
      Specifies directory name where output file(s) should be stored  
  --output <value>  
      Prefix for file name output  
 
Debug mode  
  --(no-)show-time-advance    (default: disabled)  
      Display time advance during numerical integration  
  --(no-)debug    (default: disabled)  
      Enable debug mode  
  --(no-)print-efficiency    (default: disabled)  
      prompt CPU time and various datas  
  --(no-)backtrace    (default: disabled)  
      Backtracing exceptions  
  --(no-)gluttony    (default: disabled)  
      Lower gc activity for a faster but memory intensive simulation  
  -mode batch | interactive  
 (default: interactive)  
      either "batch" to never ask anything to the user or "interactive" to  
      ask something before doing anything  
  -d <name>   (default: .)  
      Specifies directory name where output file(s) should be stored  
  --output <value>  
      Prefix for file name output  
 
(76 options)

Orders in option matter, since they can be used to toggle on/off some functionalities or to assign a value to some environment variables. The options are interpreted from left to right.

8.2 Graphical interface

8.2.1 Launching the interface

The graphical interface can be launched by typing

without any option.


PIC

Figure 8.1: KaDE  graphical interface - sub-tab Data set


8.2.2 The areas of interests

There are five different areas of importance in the graphical interface:

  1. On the top left of the window, a button allows for the selection between the Normal and the Expert mode (other modes may be available if activated at compilation). In expert modes, more options are available in the graphical interface.
  2. On the top center/right, some button allows for the selection of the tab. There are currently seven sub-tabs available: Data set, Output, Semantics, Integration settings, Model reduction, Static analysis, Debug mode. The last two tabs are activated only in expert mode (which can be selected on the top-left of the window).
  3. Center: The options of the selected sub-tab are displayed and can be tuned.

    Contextual help is provided when the mouse is hovered over an element.

    The interface will store the options that are checked or filled and the order in which they have been selected. When launched, the analysis interprets these options in the order they have been entered.

    Some options appear in several sub-tabs. They denote the same option and share the same value.

  4. File selector: The file selector can be used to upload as many kappa files as desired. The button ’Clear’ can be used to reset the selection of files.
  5. Bottom: Some buttons are available. The button ’Quit’ can be used to leave the interface. The button ’Reset to default’ tune all the options to their default value. The button ’Import options’ can be used to restore the value of the options as saved during a previous session of the graphical interfaces. The button ’Save options’ can be used to save the value of the options for a further session. The button ’Launch analyze’ launch KaDE with the current options.

    Importantly, options are saved automatically under various occasions. Thus, it is possible to restore the value of the options before the last reset, before the last quit, or before the last analysis.

Two fields define the repository and the name of the output:

Both fields may be modified from every sub-tab.

When the repository does not exist, KaDE will create it.

When the output file already exists, KaDE will ask for confirmation before overwritting it, unless the tool is set in batch mode (e.g. see Sect. 8.2.6).

8.2.3 The sub-tab Data set

The sub-tab Data set (see Fig. 8.1) contains the options to tune the time range for the numerical integration and the frequency of sample plots. These fields are used only in Maple, Mathematica, Matlab, and Octave backend formats. They are ignored in SBML and DOTNET backend formats.

8.2.4 The sub-tab Output


PIC

Figure 8.2: KaDE  graphical interface - sub-tab Output


The sub-tab Output (see Fig. 8.2) contains the names of the output files and their format.

8.2.5 The sub-tab Integration settings


PIC

Figure 8.3: KaDE  graphical interface - sub-tab Integration settings


The sub-tab Integration settings (see Fig. 8.3) contains the parameters to guide the engine of numerical integration. Except the option –smashs-reaction, these options are ignored in the SBML and in the DOTNET backend format.

8.2.6 The sub-tab Debug

In expert mode, the last sub-tab provides options to tune the amount of debugging information that is displayed.


PIC

Figure 8.4: KaDE  graphical interface - sub-tab 6_debug_mode



PIC


Figure 8.5: Proteins K and S may bind.



PIC


Figure 8.6: The protein K may activate the protein S.


8.3 Differential semantics

8.3.1 From rules to reactions

In Kappa, rules may be more and less refined [??], according to their preconditions.

Consider the following two rules:

1bind  K(r),S(l) -> K(r!1),S(l!1) @k 
2phos  K(r!1),S(l!1,r~u) -> K(r!1),S(l!1,r~p) @kp