clm

Utilities for working with CLIMB environments.

Installation

pip install .

For development:

pip install -e ".[dev]"

Usage

Show version

clm version
# or
clm --version

Show environment information

Display CLIMB notebook environment details in a table:

clm info

Output as JSON for scripting:

clm info --json

Example output:

CLIMB Notebook Information
┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Property               ┃ Value                                           ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ CLIMB Notebook         │ ✓ Yes                                           │
│                        │                                                 │
│ User                   │ telatin.qit-team-001                            │
│ Team                   │ qit-team-001                                    │
│ Hostname               │ jupyter-telatin-2eqit-2dteam-2d001              │
│ CPU Limit              │ 8.0                                             │
│ CPU Guarantee          │ 8.0                                             │
│ Memory Limit           │ 64.0 GiB                                        │
│ Memory Guarantee       │ 64.0 GiB                                        │
│ Nextflow Home          │ /shared/team/nxf_work/telatin.qit-team-001      │
│ Nextflow Work          │ /shared/team/nxf_work/telatin.qit-team-001/work │
│ JupyterHub Service URL │ http://0.0.0.0:8888/user/telatin.qit-team-001/  │
│ Jupyter Image          │ climbbigdata/jupyterhub-base:0.0.65             │
│ AWS Endpoint           │ https://s3.climb.ac.uk                          │
└────────────────────────┴─────────────────────────────────────────────────┘

Development

Run tests with:

pytest

Architecture

The package follows this structure:

clm/
├── pyproject.toml
├── src/clm/
│   ├── __init__.py         # Package version
│   ├── __main__.py         # python -m clm support
│   ├── cli.py              # Typer app entry point
│   ├── console.py          # Shared Rich console instances
│   ├── utils.py            # is_climb_notebook() helper
│   └── commands/
│       ├── version.py      # clm version
│       └── info.py         # clm info
└── tests/
    ├── test_cli.py
    ├── test_info.py
    └── test_utils.py

Future commands

Planned subcommands following the PROJECT.md roadmap:

• clm env – environment management
• clm notebook – notebook utilities
• clm storage – storage inspection and management
• clm team – team information
• clm system – system resources (CPU, memory, GPU)