Metadata-Version: 2.1
Name: kappy
Version: 4.0.91
Summary: Wrapper to interact with the Kappa tool suite
Home-page: https://github.com/Kappa-Dev/KaSim.git
Author: Kappa-Dev
Author-email: kappa-dev@listes.sc.univ-paris-diderot.fr
License: LGPLv3
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Dist: requests
Requires-Dist: future

Kappy
-----

Do

>>> import kappy
>>> client = kappy.KappaRest("http\://url_of/the_server","project_name")

to get a kappa client that uses the REST API hosted by
*http://url_of/the_server* and deals with project *project_name*.

Do

>>> import kappy
>>> client = kappy.KappaStd()

to get a kappa client that uses a kappa agent installed locally. Add a
string argument specifing the *path/to/KaSimAgent* to use a specific agent.

A kappa agent can be obtained thanks to the *opam* package manager through::

  $ opam install atdgen lwt
  $ opam pin add --dev KaSim

The methods of *client* is described in the **kappa_common.py**
file in the source distribution.

A minimal example of usage is

>>> model = "%agent: A(x[x.A]) %var: k_on 1e-2 'rule' A(x[.]), A(x[.]) <-> A(x[1]), A(x[1]) @ k_on, 1 %plot: |A(x[.])| %init: 100 A()"
>>> client.add_model_string(model)
>>> client.project_parse()
>>> sim_params = kappy.SimulationParameter(pause_condition="[T] > 100",plot_period=1)
>>> client.simulation_start(sim_params)
>>> while client.get_is_sim_running(): sleep(0.1)
>>> results = client.simulation_plot()
>>> client.shutdown()


