Metadata-Version: 2.4
Name: pykappa
Version: 0.1.9
Summary: Work with Kappa rule-based models in Python
Project-URL: Homepage, https://pykappa.org
Project-URL: Documentation, https://pykappa.org/api/index.html
Project-URL: Repository, https://github.com/berkalpay/pykappa
Project-URL: Issues, https://github.com/berkalpay/pykappa/issues
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: lark>=1.2.2
Requires-Dist: pandas>=2.0.0
Requires-Dist: matplotlib>=3.10.3
Requires-Dist: graphviz>=0.20
Provides-Extra: dev
Requires-Dist: py-spy>=0.4.0; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black==25.1.0; extra == "dev"
Requires-Dist: mypy>=1.15.0; extra == "dev"
Requires-Dist: memory-profiler>=0.61.0; extra == "dev"

<div align="center">
  <img src="https://raw.githubusercontent.com/berkalpay/pykappa/main/docs/source/_static/logo.png" width="100">
</div>

# PyKappa

[![PyPI](https://img.shields.io/pypi/v/pykappa)](https://pypi.org/project/pykappa)

PyKappa is a Python package for working with rule-based models.
It supports simulation and analysis of a wide variety of systems whose individual components interact as described by rules that transform these components in specified ways and at specified rates.
See our website [pykappa.org](https://pykappa.org) for a tutorial, examples, and documentation.


## Development

Developer requirements can be installed via:
```
pip install -e ".[dev]"
```

To run correctness tests, run `pytest`.
Running `./tests/cpu-profiles/run_profiler.sh` will CPU-profile predefined Kappa models and write the results to `tests/cpu-profiles/results`.
We use the Black code formatter, which can be run as `black .`



