Skip to main content

github actions pytest python versions PyPI version status

hillmaker

hillmaker is a Python package that computes time of day and day of week specific occupancy statistics from transaction data containing arrival and departure timestamps. Typical use is for capacity planning problems in places like hospital emergency departments, surgical recovery rooms or any system in which entities arrive, occupy capacity for some amount of time, and then depart. It gets its name from the hill-like nature of plots based on temporal occupancy statistics.

hillmaker Screenshot

  • usable via a CLI, a function based API and and objected oriented API
  • takes a pandas DataFrame or csv file as the input data type
  • computes arrival, departure and occupancy summary statistics by time of day, day of week, and entity category based on a dataframe containing one record per visit.
  • computes arrival, departure and occupancy for each datetime bin in a specified date range
  • select any time bin size (minutes) that divides evenly into a day.
  • output statistics includes sample size, mean, min, max, standard deviation, coefficient of variation, standard error, skew, kurtosis, and percentiles.
  • weekly and day of week plots can be created by default or on demand; numerous plot related input parameters are available,
  • summary report for length of stay automatically created
  • outputs are stored in a dictionary containing pandas dataframes and as matplotlib figures. These can be accessed by methods for further post-processing or for exporting to external files.
  • Requires Python >= 3.10, pandas >= 1.5.0, numpy >= 1.22, pydantic >= 2.1.1, seaborn >= 0.12.2, matplotlib >= 3.7.1, and tomli >= 2.0.1 (if not using Python 3.11)
  • MIT License

See the CHANGELOG for details on latest and older versions.

Where to get it

Installation

You can install using pip:

pip install hillmaker

You should also be able to install hillmaker from conda-forge shortly (?) into a virtual environment.

conda config --add channels conda-forge
conda config --set channel_priority strict
conda install hillmaker 

If you want to get the latest update which is not yet on PyPI or conda-forge, you can install from the GitHub repo's develop branch:

pip install git+https://github.com/misken/hillmaker@develop

Quick Start

See the Getting Started page in the hillmaker docs.

How to contribute

Use the GitHub issue tracking system to report problems with the software, seek support, or suggest improvements. Code contributions can be suggested using GitHub pull requests.

See CONTRIBUTING.rst for more details.

Learn more about the history of hillmaker

See the History page at the hillmaker docs.

Metadata

Release files for hillmaker 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hillmaker 0.8.1
File Size Uploaded Provenance Actions
hillmaker-0.8.1.tar.gz 39.2 kB Without provenance Details for hillmaker-0.8.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hillmaker 0.8.1
File Interpreter ABI Platform Actions
hillmaker-0.8.1-py3-none-any.whl Python 3 none any Details for hillmaker-0.8.1-py3-none-any.whl

Total release size: 79.2 kB

Release files / hillmaker-0.8.1.tar.gz

Download URL hillmaker-0.8.1.tar.gz
Size 39.2 kB
Tags Source
SHA-256 checksum
How to use checksums
f2f144eb442336e3882fb68d4cf5420c3eca95e7fc57e5b2fe2a5fd5418c3245
BLAKE2b-256 checksum
How to use checksums
2e4cb0ab260dd56cd1a35c2c73445008ce69d7d9fdb924c7a03d5d77dcc1513a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.13

Release files / hillmaker-0.8.1-py3-none-any.whl

Download URL hillmaker-0.8.1-py3-none-any.whl
Size 40.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
26c4344277455314d2e3efd037427719fb51291ff79d12f4e64bd4bb81fa7ebb
BLAKE2b-256 checksum
How to use checksums
f29b6bc4b3cf16cc14f5b7fd43cc0ee44544baf9ce1ae3a77e2a5d31a042f890
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.13

Security for hillmaker 0.8.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page