hpc-runner 0.1.1__tar.gz → 0.2.1__tar.gz

{hpc_runner-0.1.1 → hpc_runner-0.2.1}/CLAUDE.md

@@ -58,8 +58,76 @@ Uses `rich-click` for styled output. Commands: `run`, `status`, `cancel`, `confi
 
 Jinja2 templates for job scripts. Each scheduler has its own template in `schedulers/{name}/templates/job.sh.j2`.
 
+### TUI (`src/hpc_runner/tui/`)
+
+**HpcMonitorApp** - Textual-based terminal UI for monitoring HPC jobs. Entry point: `hpc monitor`.
+
+- **app.py** - Main application with custom Nord-inspired theme
+- **styles/monitor.tcss** - CSS styling following Rovr aesthetic (see `docs/TEXTUAL_STYLING_COOKBOOK.md`)
+- **snapshot.py** - Visual review utility for development
+
 ## Key Design Decisions
 
 - **Merged output by default**: stderr goes to stdout unless `--stderr` specified
 - **Configurable SGE settings**: PE name, memory resource name, time resource name all come from config, not hardcoded
 - **Descriptor pattern**: Scheduler arguments use Python descriptors for type-safe flag/directive generation
+
+## TUI Development Rules
+
+### Styling Requirements (CRITICAL)
+
+All TUI components MUST follow these styling patterns. **Do NOT use DEFAULT_CSS in components** - put all styles in `monitor.tcss` for consistency.
+
+**Core Principles:**
+- **Transparent backgrounds everywhere** - use `background: transparent` on all widgets
+- **Rounded borders** - use `border: round $border-blurred` (unfocused) or `border: round $border` (focused)
+- **No solid colored backgrounds** except for highlighted/selected items
+- **Border titles in $primary** - use `border-title-color: $primary`
+
+**Standard Widget Patterns:**
+```css
+/* Panels and containers */
+MyWidget {
+    background: transparent;
+    border: round $border-blurred;
+    border-title-color: $primary;
+    border-title-background: transparent;
+}
+
+MyWidget:focus, MyWidget:focus-within {
+    border: round $border;
+}
+
+/* Buttons - transparent with border */
+Button {
+    background: transparent;
+    border: round $border-blurred;
+    color: $foreground;
+}
+
+Button:hover {
+    background: $boost;
+    border: round $border;
+}
+
+/* Popups/overlays - transparent background */
+Popup {
+    layer: overlay;
+    background: transparent;
+    border: round $primary;
+}
+```
+
+**CSS Variables (defined in monitor.tcss):**
+- `$border-blurred` - muted border for unfocused elements
+- `$border` - bright border for focused elements
+- `$primary` - teal accent color (#88C0D0)
+- `$error` - red for destructive actions
+
+**Verification:**
+
+After ANY edit to TUI code, verify visually that:
+1. All backgrounds are transparent (terminal shows through)
+2. Borders are rounded (╭╮╰╯ characters)
+3. No solid color blocks except for selected/highlighted items
+4. Focus states brighten borders appropriately

hpc_runner-0.2.1/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: hpc-runner
+Version: 0.2.1
+Summary: Unified HPC job submission across multiple schedulers
+Project-URL: Homepage, https://github.com/sjalloq/hpc-runner
+Project-URL: Repository, https://github.com/sjalloq/hpc-runner
+Author: Shareef Jalloq
+License-Expression: MIT
+Keywords: cluster,hpc,job-submission,pbs,sge,slurm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Clustering
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.10
+Requires-Dist: jinja2>=3.0
+Requires-Dist: rich-click>=1.7
+Requires-Dist: textual>=6.11
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Provides-Extra: all
+Requires-Dist: build; extra == 'all'
+Requires-Dist: hatch-vcs; extra == 'all'
+Requires-Dist: mypy; extra == 'all'
+Requires-Dist: pytest-cov; extra == 'all'
+Requires-Dist: pytest>=7.0; extra == 'all'
+Requires-Dist: ruff; extra == 'all'
+Requires-Dist: twine; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: hatch-vcs; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# hpc-runner
+
+**Unified HPC job submission across multiple schedulers**
+
+Write your jobs once, run them on any cluster - SGE, Slurm, PBS, or locally for testing.
+
+## Features
+
+- **Unified CLI** - Same commands work across SGE, Slurm, PBS
+- **Python API** - Programmatic job submission with dependencies and pipelines
+- **Auto-detection** - Automatically finds your cluster's scheduler
+- **Interactive TUI** - Monitor jobs with a terminal dashboard
+- **Job Dependencies** - Chain jobs with afterok, afterany, afternotok
+- **Array Jobs** - Batch processing with throttling support
+- **Virtual Environment Handling** - Automatic venv activation on compute nodes
+- **Module Integration** - Load environment modules in job scripts
+- **Dry-run Mode** - Preview generated scripts before submission
+
+## Installation
+
+```bash
+pip install hpc-runner
+```
+
+Or with uv:
+
+```bash
+uv pip install hpc-runner
+```
+
+## Quick Start
+
+### CLI
+
+```bash
+# Basic job submission
+hpc run python train.py
+
+# With resources
+hpc run --cpu 4 --mem 16G --time 4:00:00 "python train.py"
+
+# GPU job
+hpc run --queue gpu --cpu 4 --mem 32G "python train.py --epochs 100"
+
+# Preview without submitting
+hpc run --dry-run --cpu 8 "make -j8"
+
+# Interactive session
+hpc run --interactive bash
+
+# Array job
+hpc run --array 1-100 "python process.py --task-id \$SGE_TASK_ID"
+
+# Wait for completion
+hpc run --wait python long_job.py
+```
+
+### Python API
+
+```python
+from hpc_runner import Job
+
+# Create and submit a job
+job = Job(
+    command="python train.py",
+    cpu=4,
+    mem="16G",
+    time="4:00:00",
+    queue="gpu",
+)
+result = job.submit()
+
+# Wait for completion
+status = result.wait()
+print(f"Exit code: {result.returncode}")
+
+# Read output
+print(result.read_stdout())
+```
+
+### Job Dependencies
+
+```python
+from hpc_runner import Job
+
+# First job
+preprocess = Job(command="python preprocess.py", cpu=8, mem="32G")
+result1 = preprocess.submit()
+
+# Second job runs after first succeeds
+train = Job(command="python train.py", cpu=4, mem="48G", queue="gpu")
+train.after(result1, type="afterok")
+result2 = train.submit()
+```
+
+### Pipelines
+
+```python
+from hpc_runner import Pipeline
+
+with Pipeline("ml_workflow") as p:
+    p.add("python preprocess.py", name="preprocess", cpu=8)
+    p.add("python train.py", name="train", depends_on=["preprocess"], queue="gpu")
+    p.add("python evaluate.py", name="evaluate", depends_on=["train"])
+
+results = p.submit()
+p.wait()
+```
+
+## Scheduler Support
+
+| Scheduler | Status | Notes |
+|-----------|--------|-------|
+| SGE | Fully implemented | qsub, qstat, qdel, qrsh |
+| Local | Fully implemented | Run as subprocess (for testing) |
+| Slurm | Planned | sbatch, squeue, scancel |
+| PBS | Planned | qsub, qstat, qdel |
+
+### Auto-detection Priority
+
+1. `HPC_SCHEDULER` environment variable
+2. SGE (`SGE_ROOT` or `qstat` available)
+3. Slurm (`sbatch` available)
+4. PBS (`qsub` with PBS)
+5. Local fallback
+
+## Configuration
+
+hpc-runner uses TOML configuration files. Location priority:
+
+1. `--config /path/to/config.toml`
+2. `./hpc-tools.toml`
+3. `./pyproject.toml` under `[tool.hpc-tools]`
+4. Git repository root `hpc-tools.toml`
+5. `~/.config/hpc-tools/config.toml`
+6. Package defaults
+
+### Example Configuration
+
+```toml
+[defaults]
+cpu = 1
+mem = "4G"
+time = "1:00:00"
+inherit_env = true
+
+[schedulers.sge]
+parallel_environment = "smp"
+memory_resource = "mem_free"
+purge_modules = true
+
+[types.gpu]
+queue = "gpu"
+resources = [{name = "gpu", value = 1}]
+
+[types.interactive]
+queue = "interactive"
+time = "8:00:00"
+```
+
+Use named job types:
+
+```bash
+hpc run --job-type gpu "python train.py"
+```
+
+## TUI Monitor
+
+Launch the interactive job monitor:
+
+```bash
+hpc monitor
+```
+
+Key bindings:
+- `q` - Quit
+- `r` - Refresh
+- `u` - Toggle user filter (my jobs / all)
+- `/` - Search
+- `Enter` - View job details
+- `Tab` - Switch tabs
+
+## CLI Reference
+
+```
+hpc run [OPTIONS] COMMAND
+
+Options:
+  --job-name TEXT       Job name
+  --cpu INTEGER         Number of CPUs
+  --mem TEXT            Memory (e.g., 16G, 4096M)
+  --time TEXT           Time limit (e.g., 4:00:00)
+  --queue TEXT          Queue/partition name
+  --directory PATH      Working directory
+  --module TEXT         Module to load (repeatable)
+  --array TEXT          Array spec (e.g., 1-100, 1-100%5)
+  --depend TEXT         Job dependencies
+  --inherit-env         Inherit environment (default: true)
+  --no-inherit-env      Don't inherit environment
+  --interactive         Run interactively (qrsh/srun)
+  --local               Run locally (no scheduler)
+  --dry-run             Show script without submitting
+  --wait                Wait for completion
+  --keep-script         Keep job script for debugging
+  -h, --help            Show help
+
+Other commands:
+  hpc status [JOB_ID]   Check job status
+  hpc cancel JOB_ID     Cancel a job
+  hpc monitor           Interactive TUI
+  hpc config show       Show active configuration
+```
+
+## Development
+
+```bash
+# Setup environment
+source sourceme
+source sourceme --clean  # Clean rebuild
+
+# Run tests
+pytest
+pytest -v
+pytest -k "test_job"
+
+# Type checking
+mypy src/hpc_runner
+
+# Linting
+ruff check src/hpc_runner
+ruff format src/hpc_runner
+```
+
+## Documentation
+
+- [Programmatic API Reference](docs/programmatic_api.md)
+- [TUI Styling Guide](docs/TEXTUAL_STYLING_COOKBOOK.md)
+
+## License
+
+MIT License - see LICENSE file for details.

hpc_runner-0.2.1/README.md

@@ -0,0 +1,241 @@
+# hpc-runner
+
+**Unified HPC job submission across multiple schedulers**
+
+Write your jobs once, run them on any cluster - SGE, Slurm, PBS, or locally for testing.
+
+## Features
+
+- **Unified CLI** - Same commands work across SGE, Slurm, PBS
+- **Python API** - Programmatic job submission with dependencies and pipelines
+- **Auto-detection** - Automatically finds your cluster's scheduler
+- **Interactive TUI** - Monitor jobs with a terminal dashboard
+- **Job Dependencies** - Chain jobs with afterok, afterany, afternotok
+- **Array Jobs** - Batch processing with throttling support
+- **Virtual Environment Handling** - Automatic venv activation on compute nodes
+- **Module Integration** - Load environment modules in job scripts
+- **Dry-run Mode** - Preview generated scripts before submission
+
+## Installation
+
+```bash
+pip install hpc-runner
+```
+
+Or with uv:
+
+```bash
+uv pip install hpc-runner
+```
+
+## Quick Start
+
+### CLI
+
+```bash
+# Basic job submission
+hpc run python train.py
+
+# With resources
+hpc run --cpu 4 --mem 16G --time 4:00:00 "python train.py"
+
+# GPU job
+hpc run --queue gpu --cpu 4 --mem 32G "python train.py --epochs 100"
+
+# Preview without submitting
+hpc run --dry-run --cpu 8 "make -j8"
+
+# Interactive session
+hpc run --interactive bash
+
+# Array job
+hpc run --array 1-100 "python process.py --task-id \$SGE_TASK_ID"
+
+# Wait for completion
+hpc run --wait python long_job.py
+```
+
+### Python API
+
+```python
+from hpc_runner import Job
+
+# Create and submit a job
+job = Job(
+    command="python train.py",
+    cpu=4,
+    mem="16G",
+    time="4:00:00",
+    queue="gpu",
+)
+result = job.submit()
+
+# Wait for completion
+status = result.wait()
+print(f"Exit code: {result.returncode}")
+
+# Read output
+print(result.read_stdout())
+```
+
+### Job Dependencies
+
+```python
+from hpc_runner import Job
+
+# First job
+preprocess = Job(command="python preprocess.py", cpu=8, mem="32G")
+result1 = preprocess.submit()
+
+# Second job runs after first succeeds
+train = Job(command="python train.py", cpu=4, mem="48G", queue="gpu")
+train.after(result1, type="afterok")
+result2 = train.submit()
+```
+
+### Pipelines
+
+```python
+from hpc_runner import Pipeline
+
+with Pipeline("ml_workflow") as p:
+    p.add("python preprocess.py", name="preprocess", cpu=8)
+    p.add("python train.py", name="train", depends_on=["preprocess"], queue="gpu")
+    p.add("python evaluate.py", name="evaluate", depends_on=["train"])
+
+results = p.submit()
+p.wait()
+```
+
+## Scheduler Support
+
+| Scheduler | Status | Notes |
+|-----------|--------|-------|
+| SGE | Fully implemented | qsub, qstat, qdel, qrsh |
+| Local | Fully implemented | Run as subprocess (for testing) |
+| Slurm | Planned | sbatch, squeue, scancel |
+| PBS | Planned | qsub, qstat, qdel |
+
+### Auto-detection Priority
+
+1. `HPC_SCHEDULER` environment variable
+2. SGE (`SGE_ROOT` or `qstat` available)
+3. Slurm (`sbatch` available)
+4. PBS (`qsub` with PBS)
+5. Local fallback
+
+## Configuration
+
+hpc-runner uses TOML configuration files. Location priority:
+
+1. `--config /path/to/config.toml`
+2. `./hpc-tools.toml`
+3. `./pyproject.toml` under `[tool.hpc-tools]`
+4. Git repository root `hpc-tools.toml`
+5. `~/.config/hpc-tools/config.toml`
+6. Package defaults
+
+### Example Configuration
+
+```toml
+[defaults]
+cpu = 1
+mem = "4G"
+time = "1:00:00"
+inherit_env = true
+
+[schedulers.sge]
+parallel_environment = "smp"
+memory_resource = "mem_free"
+purge_modules = true
+
+[types.gpu]
+queue = "gpu"
+resources = [{name = "gpu", value = 1}]
+
+[types.interactive]
+queue = "interactive"
+time = "8:00:00"
+```
+
+Use named job types:
+
+```bash
+hpc run --job-type gpu "python train.py"
+```
+
+## TUI Monitor
+
+Launch the interactive job monitor:
+
+```bash
+hpc monitor
+```
+
+Key bindings:
+- `q` - Quit
+- `r` - Refresh
+- `u` - Toggle user filter (my jobs / all)
+- `/` - Search
+- `Enter` - View job details
+- `Tab` - Switch tabs
+
+## CLI Reference
+
+```
+hpc run [OPTIONS] COMMAND
+
+Options:
+  --job-name TEXT       Job name
+  --cpu INTEGER         Number of CPUs
+  --mem TEXT            Memory (e.g., 16G, 4096M)
+  --time TEXT           Time limit (e.g., 4:00:00)
+  --queue TEXT          Queue/partition name
+  --directory PATH      Working directory
+  --module TEXT         Module to load (repeatable)
+  --array TEXT          Array spec (e.g., 1-100, 1-100%5)
+  --depend TEXT         Job dependencies
+  --inherit-env         Inherit environment (default: true)
+  --no-inherit-env      Don't inherit environment
+  --interactive         Run interactively (qrsh/srun)
+  --local               Run locally (no scheduler)
+  --dry-run             Show script without submitting
+  --wait                Wait for completion
+  --keep-script         Keep job script for debugging
+  -h, --help            Show help
+
+Other commands:
+  hpc status [JOB_ID]   Check job status
+  hpc cancel JOB_ID     Cancel a job
+  hpc monitor           Interactive TUI
+  hpc config show       Show active configuration
+```
+
+## Development
+
+```bash
+# Setup environment
+source sourceme
+source sourceme --clean  # Clean rebuild
+
+# Run tests
+pytest
+pytest -v
+pytest -k "test_job"
+
+# Type checking
+mypy src/hpc_runner
+
+# Linting
+ruff check src/hpc_runner
+ruff format src/hpc_runner
+```
+
+## Documentation
+
+- [Programmatic API Reference](docs/programmatic_api.md)
+- [TUI Styling Guide](docs/TEXTUAL_STYLING_COOKBOOK.md)
+
+## License
+
+MIT License - see LICENSE file for details.

{hpc_runner-0.1.1 → hpc_runner-0.2.1}/defaults/config.toml

@@ -16,6 +16,15 @@ memory_resource = "mem_free"
 time_resource = "h_rt"
 merge_output = true
 
+# Module handling
+purge_modules = false       # Run 'module purge' before loading modules
+silent_modules = false      # Use -s flag for silent module operations
+module_init_script = ""     # Site-specific module init (empty = auto-detect)
+
+# Environment handling
+expand_makeflags = true     # Expand $NSLOTS in MAKEFLAGS
+unset_vars = []             # Environment variables to unset (e.g., ["https_proxy"])
+
 # Slurm-specific settings (for future use)
 [schedulers.slurm]
 # Default Slurm settings