Metadata-Version: 2.1
Name: pycmdstan
Version: 0.9
Summary: Python interface to CmdStan
Home-page: https://gitlab.thevirtualbrain.org/tvb/pycmdstan
Author: Marmaduke Woodman
Author-email: marmaduke.woodman@univ-amu.fr
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Other
Classifier: Programming Language :: C++
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: filelock
Requires-Dist: matplotlib

# pycmdstan

[![pipeline status](https://gitlab.thevirtualbrain.org/tvb/pycmdstan/badges/master/pipeline.svg)](https://gitlab.thevirtualbrain.org/tvb/pycmdstan/commits/master) [![coverage report](https://gitlab.thevirtualbrain.org/tvb/pycmdstan/badges/master/coverage.svg)](https://gitlab.thevirtualbrain.org/tvb/pycmdstan/commits/master) [![PyPI package version](https://img.shields.io/pypi/v/pycmdstan.svg)](https://pypi.org/project/pycmdstan/) [![Documentation Status](https://readthedocs.org/projects/pycmdstan/badge/?version=latest)](https://pycmdstan.readthedocs.io/en/latest/?badge=latest)

Python interface to CmdStan.

## Usage
After installing,  `pip install -U pycmdstan`, a contrived example would be
```python
from pycmdstan import Model, Run

model = Model('''
data { vector[20] x; real mu; }
parameters { real sig; }
model { x ~ normal(mu, sig); }
''')

assert model.sample(data={'mu': 5.0, x: randn(20)}, chains=4).R_hat.max() < 1.2
```
See the [docs](https://pycmdstan.readthedocs.io/en/latest/) for more.

## Contributing

Contributions are welcome, please start in the issue tracker. 
Use YAPF to format the code.  The Dockerfile can ease local development, 
```
docker build -t pycmdstan .
docker run --rm -it pycmdstan pytest -n4 pycmdstan/tests.py
```

## Acknowledgements

- PSIS code is by Aki Vehtari & Tuomas Sivula (BSD licensed, [repo here](https://github.com/avehtari/PSIS))

