pyerrors/README.md

28 lines
1.5 KiB
Markdown
Raw Normal View History

2021-11-07 21:17:06 +00:00
[![flake8](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml) [![pytest](https://github.com/fjosw/pyerrors/actions/workflows/pytest.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/pytest.yml) [![docs](https://github.com/fjosw/pyerrors/actions/workflows/docs.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/docs.yml) [![](https://img.shields.io/badge/python-3.6+-blue.svg)](https://www.python.org/downloads/)
2020-10-13 16:53:00 +02:00
# pyerrors
2021-10-15 12:29:58 +01:00
`pyerrors` is a python package for error computation and propagation of Markov chain Monte Carlo data.
2020-10-13 16:53:00 +02:00
2021-11-07 21:03:08 +00:00
- **Documentation:** https://fjosw.github.io/pyerrors/pyerrors.html
- **Examples**: https://github.com/fjosw/pyerrors/tree/develop/examples
- **Contributing:** https://github.com/fjosw/pyerrors/blob/develop/CONTRIBUTING.md
2021-11-07 21:17:06 +00:00
- **Bug reports:** https://github.com/fjosw/pyerrors/issues
2020-10-13 16:53:00 +02:00
## Installation
2021-10-19 10:34:03 +01:00
To install the most recent release of `pyerrors` run
2020-10-13 16:53:00 +02:00
```bash
2021-10-23 17:02:50 +01:00
pip install git+https://github.com/fjosw/pyerrors.git@master
```
to install the current `develop` version run
```bash
pip install git+https://github.com/fjosw/pyerrors.git@develop
2020-10-13 16:53:00 +02:00
```
2021-11-07 21:17:06 +00:00
## Other implementations
2021-11-07 21:03:08 +00:00
There exist similar implementations of gamma method error analysis suites in
- [Fortran](https://gitlab.ift.uam-csic.es/alberto/aderrors)
- [Julia](https://gitlab.ift.uam-csic.es/alberto/aderrors.jl)
2021-11-07 21:17:06 +00:00
- [Python](https://github.com/mbruno46/pyobs)
2020-10-13 16:53:00 +02:00
## License
[MIT](https://choosealicense.com/licenses/mit/)