https://github.com/4ment/logstat
https://github.com/4ment/logstat
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/4ment/logstat
- Owner: 4ment
- License: gpl-3.0
- Created: 2024-04-19T07:38:28.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T05:48:01.000Z (about 2 years ago)
- Last Synced: 2024-12-27T04:42:25.328Z (over 1 year ago)
- Language: Python
- Size: 27.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# logstat
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/psf/black)
`logstat` is a simple program replicating some of [tracer]'s functionalities. It takes a posterior sample as input and outputs the effective sample size (ESS) and statistics such as the mean, meadian, and 95% higher posterior density (HPD).
### Dependencies
- [numpy]
- [polars]
### Installation
To install logstat from source you can run
```bash
pip install git+https://github.com/4ment/logstat
```
or
```bash
git clone https://github.com/4ment/logstat
pip install logstat/
```
Check install
```bash
logstat --help
```
## Quick start
`logstat` parses log files generated by programs such as `beast`.
```bash
logstat summarize samples.log --burnin 0.2
```
Multiple sample files can be provided and the burnin can be specified for each of them using the same order.
```bash
logstat summarize samples1.log samples2.log --burnin 0.2 --burnin 0.3
```
## License
Distributed under the GPLv3 License. See [LICENSE](LICENSE) for more information.
## Acknowledgements
`logstat` makes use of the following libraries and tools, which are under their own respective licenses:
- [numpy]
- [polars]
[numpy]: https://github.com/numpy/numpy
[polars]: https://github.com/pola-rs/polars
[tracer]: https://github.com/beast-dev/tracer