All Kappa software is open source. Its development is hosted on github.

Please report any issues  you encounter.

Join the discussion through any channel listed in the Contact section if you wish to delve into source code.

Released version

Command line and graphical user interface

The Kappa User Interface (KUI) integrates the simulator with a variety of analysis tools. It provides some graphics to facilitate reasoning about a Kappa model and its behavior.

The command line versions of the Kappa tools are located inside the app directory along with the UI. ("Inspect package content" of under MacOSX).

To draw graphs generated by the command line versions of the Kappa tools, you will need Graphviz or any graph visualizer that accepts the dot format.

A UI is always work in progress and there are several interesting Kappa tools that have not yet been integrated. Feedback is important to us.

Programatic interface

Kappa is available as an API from a python. This the kappy package (available in pip). A toy minimal session in ipython using looks like:

In [2]: import kappy

In [3]: model_text = "%agent: A(x)\nA(x[.]), A(x[.]) <-> A(x[1]), A(x[1]) @ 1e-2,1\n%plot: |A(x[.])|\n%init: 100 A()"

In [4]: kappa_client = kappy.KappaStd()

In [5]: kappa_client.add_model_string(model_text)
Out[5]: [...]

In [6]: kappa_client.project_parse()
Out[6]: [...]

In [7]: kappa_client.simulation_start(kappy.SimulationParameter(.1,"[T] > 10"))
Out[7]: {'simulation_artifact_simulation_seed': 297327779}

In [8]: kappa_client.wait_for_simulation_stop()
Out[8]: [...]

In [9]: kappa_client.simulation_plot()
  [6.7, 48.0],
  [0.4, 60.0],
  [0.3, 50.0],
  [0.2, 64.0],
  [0.1, 62.0],
  [0.0, 100.0]]}

Development version

If you would like to be at the cutting edge, download the nightly-builds of the development version.

Kappa software is written in the OCaml language and compiling the software therefore requires to set up a minimal OCaml environment. For this you need opam, the OCaml package manager, which is available for many (linux, bsd) distributions as well as macports, homebrew, etc.

Once opam is installed and initialized (by issuing opam init in a terminal), simply type opam pin add --dev KaSim. This will compile all necessary dependencies as well as the current master branch of the git repository.

If you would like to get WebSim (the Kappa REST service server), type opam install atdgen cohttp-lwt-unix. Opam will recognize that you now have an optional dependency of KaSim with new capabilities and will recompile everything enabling them!

Integration with editors

Under Linux, we recommend using the GNU Emacs text editor because it has a Kappa mode that you can install.

Under Windows, there is a simple syntax highlighter for the Notepad++ text editor. It looks like this:

syntax highlighter Notepad++

To install the Kappa mode for Notepad++, just download the highlighter .xml file, then go to the Language Menu -> DefineYourLanguage -> Import, and select the file you just downloaded.