Guidepost
Guidepost is a Python library for visualizing High Performance Computing (HPC) job data in Jupyter notebooks. It turns a pandas DataFrame of job records into a single, linked, interactive overview — faceted heatmaps framed by histograms, a categorical bar chart, and a brushable color legend — so you can spot patterns in runtimes, queue waits, and resource usage, then export the exact records you care about back into Python.
Installation
pip install guidepost
Quick start
from guidepost import Guidepost
import pandas as pd
gp = Guidepost()
gp.load_data(pd.read_parquet("data/jobs_data.parquet"))
gp # display in a notebook cell
Brush the heatmap or its histograms, then pull the selected rows back into Python:
df = gp.selection.dataframe
Input is a pandas DataFrame with at least three numeric and two categorical columns (datetime columns are supported on the x-axis).
Documentation
Full documentation lives in the Guidepost Wiki:
- Getting Started
- Data Requirements and Type Detection
- Configuration
- Understanding the Views — and the per-view interaction guides
- Selecting and Exporting Data
- API Reference
- FAQ and Troubleshooting
Contributing
Contributions are welcome. Fork the repository, create a branch for your feature or bugfix, and open a pull request with a description of your changes.
License
Guidepost is licensed under the MIT License. See the LICENSE file for details.
Acknowledgments
Guidepost was developed under the auspices and with funding provided by the National Renewable Energy Laboratory (NREL), the National Science Foundation under NSF IIS-1844573 and IIS-2324465, and the Department of Energy under DE-SC0022044 and DE-SC0024635.
Contact
For questions or feedback, reach out to the maintainer at [cscullyallison@sci.utah.edu].
1 maintainer
Release files for guidepost 0.3.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| guidepost-0.3.3.tar.gz | 508.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| guidepost-0.3.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.0 MB
Release files / guidepost-0.3.3.tar.gz
| Download URL | guidepost-0.3.3.tar.gz |
|---|---|
| Size | 508.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a4f573c9b525bbb161d7b33c8518f882e64217f6efe8db620f8efd3572ec109d
|
|
BLAKE2b-256 checksum How to use checksums |
e1960a20417c11e8c537f5c174ddd87680cb72f2b6e6b534f307759c356e41c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.5
|
Release files / guidepost-0.3.3-py3-none-any.whl
| Download URL | guidepost-0.3.3-py3-none-any.whl |
|---|---|
| Size | 507.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
80995f80e0c4eba03fee7c2f3eeb640373ec54c148a696b54740c73dbfc3dc86
|
|
BLAKE2b-256 checksum How to use checksums |
cf46a99657334c28a18269b08f458c4bfb9669688e8cd023f1ed8ed67ec5424e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.5
|
