guidepost 0.2.2__py3-none-any.whl

guidepost/__init__.py

@@ -0,0 +1,2 @@
+from .guidepost import Guidepost
+

guidepost/guidepost.py

@@ -0,0 +1,26 @@
+import anywidget
+import traitlets
+import pandas as pd
+import json
+import os
+
+class Guidepost(anywidget.AnyWidget):
+    _esm = os.path.join(os.path.dirname(__file__), "guidepost.js")
+    vis_data = traitlets.Dict({}).tag(sync=True)
+    vis_configs = traitlets.Dict({
+        'x': 'submit_time',
+        'y': 'queue_wait',
+        'color': 'nodes_req',
+        'color_agg': 'avg',
+        'categorical': 'user'}).tag(sync=True)
+    selected_records = traitlets.Unicode("[]").tag(sync=True)
+    records_df = pd.DataFrame()
+
+    def retrieve_selected_data(self):
+        obj = json.loads(self.selected_records)
+        self.records_df = pd.DataFrame()
+        
+        for val in obj:
+            self.records_df = pd.concat([self.records_df, pd.DataFrame.from_records(obj[val])])
+            
+        return self.records_df

guidepost/version.py

@@ -0,0 +1,2 @@
+__version_info__ = ("0", "2", "2")
+__version__ = ".".join(__version_info__)

guidepost-0.2.2.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 National Renewable Energy Laboratory
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

guidepost-0.2.2.dist-info/METADATA

@@ -0,0 +1,127 @@
+Metadata-Version: 2.2
+Name: guidepost
+Version: 0.2.2
+Summary: Guidepost. An overview visualization for understanding supercomputer queue data.
+Home-page: https://github.com/cscully-allison/guidepost
+Author: Connor Scully-Allison
+Author-email: cscullyallison@sci.utah.edu
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: scikit-learn
+Requires-Dist: anywidget
+Requires-Dist: traitlets
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Guidepost
+
+Guidepost is a Python library designed for seamless integration into Jupyter notebooks to visualize High Performance Computing (HPC) job data. It simplifies the process of understanding HPC workloads by providing a single, interactive visualization that offers an intuitive overview of job performance, resource usage, and other critical metrics.
+
+---
+
+## Features
+
+- **Jupyter Notebook Integration**: Designed for your existing workflow. Load and interact with the visualization directly in your Jupyter environment.
+- **HPC Job Data Insights**: Visualize key metrics, including job runtimes, resource usage, and queue performance.
+- **Interactive Exploration**: Export selections of specific jobs or groups of jobs for deeper analysis.
+- **Lightweight and Easy to Use**: Focused on simplicity and efficiency for HPC users.
+
+---
+
+## Installation
+
+Guidepost is available on PyPI. You can install it using pip:
+
+```bash
+pip install guidepost
+```
+
+---
+
+## Quick Start
+
+### 1. Import Guidepost
+
+```python
+import guidepost as gp
+```
+
+### 2. Load Your Data
+Guidepost supports input data in CSV or Pandas DataFrame format. Ensure your data includes columns such as job IDs, runtime, and resource usage.
+
+```python
+import pandas as pd
+
+data = pd.read_csv("hpc_jobs.csv")
+```
+
+### 3. Generate Visualization
+
+```python
+gp.load_visualization(data)
+```
+
+Run the above command in a Jupyter notebook cell to render the visualization directly.
+
+---
+
+## Example Dataset
+Below is an example of the kind of data Guidepost works with:
+
+| Job ID | Runtime (hours) | Nodes Used | partition | Status |
+|--------|-----------------|------------|-----------|--------|
+| 12345  | 5.2             | 10         | short | Complete |
+| 12346  | 12.0            | 20         | long  | Running  |
+
+Note that a column named "parition" must be sepecified.
+
+---
+
+## API Reference
+
+### `load_visualization(data)`
+- **Description**: Renders the HPC job data visualization in the current Jupyter notebook.
+- **Parameters**:
+  - `data` (DataFrame or str): A Pandas DataFrame or a path to a CSV file containing HPC job data.
+
+---
+
+## Contributing
+
+Contributions to Guidepost are welcome! To contribute:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Submit a pull request with a detailed description of your changes.
+
+---
+
+## License
+
+Guidepost is licensed under the MIT License. See the `LICENSE` file for details.
+
+---
+
+## Acknowledgments
+
+Guidepost was developed to simplify the analysis of HPC workloads, inspired by the challenges faced by HPC administrators and researchers. Thank you to the open-source community for their support and tools.
+
+---
+
+## Contact
+
+For questions or feedback, please reach out to the maintainers at [your-email@example.com].
+

guidepost-0.2.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+guidepost/__init__.py,sha256=dyd2tCYC5XbacEeYRirs55X6m6O2wBwAYFc1HcuQq7s,34
+guidepost/guidepost.py,sha256=QAWMd41KlJhBNoeZlZZiCiymUIxsJGIi4fqUljsaa0Y,820
+guidepost/version.py,sha256=xT2bIon4QyL3aVZ-RbpCfn8MeVNGs31ViCVHjJupLQM,75
+tutorials/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+guidepost-0.2.2.dist-info/LICENSE,sha256=vGvo_SrjyJT5rDPGqa7cc4tUg0X_wfTpfYuKsXNBzgE,1092
+guidepost-0.2.2.dist-info/METADATA,sha256=NIP5mr601lxX0ezLhscX1h7JJtXv5IuFmWkPUp0KIeg,3587
+guidepost-0.2.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+guidepost-0.2.2.dist-info/top_level.txt,sha256=nmP_GVoP2C46xLkyyEfONBeOSsyULb6YD-agVXOXd_Y,20
+guidepost-0.2.2.dist-info/RECORD,,

guidepost-0.2.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

guidepost-0.2.2.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+guidepost
+tutorials