https://github.com/lbann/pyyogrt
https://github.com/lbann/pyyogrt
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lbann/pyyogrt
- Owner: LBANN
- License: other
- Created: 2024-10-03T19:23:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-03T08:01:16.000Z (9 months ago)
- Last Synced: 2025-09-03T10:07:38.793Z (9 months ago)
- Language: Python
- Size: 7.81 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Your One Get Remaining Time library, in Python
==============================================
Python bindings to [libyogrt](https://github.com/LLNL/libyogrt), a library to efficiently query resource managers for the time remaining in a job.
This is useful for managing activities like checkpoint/restart, which you may want to do before a job allocation completes.
## Installation
You must install libyogrt yourself. (If you are on an LLNL system, it is probably already installed.)
Then:
```bash
# (clone PyYogrt)
cd pyyogrt
pip install .
```
(In the future, PyYogrt will be available in PyPI.)
PyYogrt attempts to find libyogrt automatically using standard search paths and compiler information.
If this fails, you can try setting the following environment variables:
* `YOGRT_INCLUDE_PATH`: Path to the directory containing `yogrt.h`.
* `YOGRT_LIBRARY_PATH`: Path to the directory containing `libyogrt.so`.
## Usage
```py
import yogrt
# Get remaining time in seconds:
remaining = yogrt.get_remaining()
```
See `help(yogrt)` or the libyogrt documentation for other methods, but `get_remaining()` is all you need most of the time.