Skip to main content

cluv

cluv — sync UV-based Python projects across HPC clusters.

Status

In early development. Commands are functional, but expect bugs or missing features.

Requirements

  • Python >= 3.11
  • UV
  • SSH access configured for each cluster in ~/.ssh/config
  • A GitHub repository with your project

Installation

To add cluv to your project, use uv add or pip install:

uv add cluster-uv

To also include the Cluv Hydra launcher:

uv add cluster-uv[hydra]

Install as a command-line tool in an isolated environment:

uv tool install cluster-uv

If you want the bleeding edge version from GitHub, use:

uv add git+https://github.com/mila-iqia/cluv

Then you can run cluv directly as a command:

cluv init
cluv login mila
cluv sync mila
cluv submit mila job.sh

Documentation

  • Cluv is documented at https://mila-iqia.github.io/cluv/.
  • Command line help : Use cluv --help or cluv <command> --help.
  • Examples : See the examples folder for sample projects using cluv. Each example includes a README with instructions specific to that project.

Quick Start

  1. Initialize your project with:
    cluv init
    
  2. Establish SSH connections to all configured clusters:
    cluv login
    
  3. Sync your project to all clusters and run uv sync on each:
    cluv sync
    

Configuration

Add a [tool.cluv] section to the pyproject.toml of your project to manage the behavior of the tool. The command cluv init will add a default config if it doesn't already exists in the .toml.

See the config at the project root for an example, or refer to the docs.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cluster_uv-0.1.1.tar.gz (240.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cluster_uv-0.1.1-py3-none-any.whl (75.7 kB view details)

Uploaded Python 3

File details

Details for the file cluster_uv-0.1.1.tar.gz.

File metadata

  • Download URL: cluster_uv-0.1.1.tar.gz
  • Upload date:
  • Size: 240.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cluster_uv-0.1.1.tar.gz
Algorithm Hash digest
SHA256 85ff0b976b0bc4686daf98f18e843cae02f366911974093f68681b4fe88cdd24
MD5 70fcf4ebec9f3a612ba5cd70397f9efe
BLAKE2b-256 c65245e43590062cc88fb0306158c9913b3d6a30e367273ff8d4627acc6c0a3f

See more details on using hashes here.

Provenance

The following attestation bundles were made for cluster_uv-0.1.1.tar.gz:

Publisher: publish.yaml on mila-iqia/cluv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cluster_uv-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cluster_uv-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 75.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cluster_uv-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2ec1dc29f85402e112f29adeabf632326f90fed63d8819e43f49f83b173ac2e0
MD5 6dd2d3c3ecc3e1643e2186826cd7368e
BLAKE2b-256 61810dc4ccf160d2b25af3efd402c09c29d33101be5922fbc76f54ed5d86ab2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for cluster_uv-0.1.1-py3-none-any.whl:

Publisher: publish.yaml on mila-iqia/cluv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

This release

0.1.1 This release

2 files

0.1.0

2 files

0.0.2

2 files

0.0.1.post1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page