Metadata-Version: 2.1
Name: pycute
Version: 0.1.0
Summary: Information-Theoretic Causal Inference on Event Sequences
Home-page: https://github.com/kailashbuki/pycute
Author: Kailash Budhathoki
Author-email: kailash.buki@gmail.com
License: MIT License
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: tqdm
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: pytest

Pycute
-------

Pycute is a infromation-theoretic causal inference method for event sequences based on Granger-causality.

Pycute Module Installation
----------------------------

The recommended way to install the `pycute` module is to simply use `pip`:

```console
$ pip install pycute
```
Pycute officially supports Python >= 3.6.

How to use pycute?
------------------
```pycon
>>> X = [1] * 1000
>>> Y = [-1] * 1000
>>> from pycute import cute, tent, simulations
>>> cute.cute(X, Y)                                                   # CUTE
(0.0, 0.0)
>>> tent.tent(X, Y)                                                   # TENT
(0.0, 0.0)
>>> simulations.simulate_decision_rate_against_data_type('/results/dir/')
# for decision rate vs causal relationship type plots
...
```

How to cite the paper?
----------------------
Todo: Add the citation to thesis.


