Skip to main content

Poisson bootstrap histogram.

Project description

bootstraphistogram

Github Build Status Documentation Status PyPI License: MIT Last Commit

A python package that provides a multi-dimensional histogram with automatic Poisson bootstrap re-sampling.

Installation

Install with pip from PyPI:

python -m pip install bootstraphistogram

Usage Instructions

For usage instructions and examples see the documentation at: https://bootstraphistogram.readthedocs.io.

Development Instructions

For Linux systems, the provided setup script will setup a suitable python virtual environment and install pre-commit-hooks.

source setup.sh

Alternatively, a Dockerfile is provided for a consistent development environment.

docker build -tbootstraphistogram:latest . && \
docker start bootstraphistogram && \
docker run --name bootstraphistogram -it -d bootstraphistogram:latest /bin/bash

This package uses Python poetry for dependency management.

poetry install

To run the unit tests run:

poetry run pytest

To build documentation run:

poetry run pip install -r docs/requirements.txt && \
poetry run sphinx-build -W docs docs-build

To auto-build the documentation while editing:

poetry run pip install sphinx-autobuild && sphinx-autobuild docs docs/_build/html 

and find your documentation on http://localhost:8000.

To generate a test coverage report run:

poetry run coverage run -m pytest tests && poetry run coverage report -m

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bootstraphistogram-0.10.0.tar.gz (11.6 kB view hashes)

Uploaded source

Built Distribution

bootstraphistogram-0.10.0-py3-none-any.whl (15.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page