Skip to main content

Iterative HPC function development. As many 'first tries' as you need.

Project description

Home of hog ☀️🦫🕳️

Groundhog Logo

Quickstart

Groundhog makes it easy to run, tweak, and re-run python functions on HPC clusters via Globus Compute using simple decorators.

Groundhog automatically manages remote environments (powered by uv)—just update Python versions or dependencies in your script, no SSH needed.

Key concepts:

  • @hog.function() - Configures a function to run on a Globus Compute endpoint. Decorator kwargs (like endpoint, account) become the default user_endpoint_config.
  • @hog.harness() - Marks a local entry point that orchestrates remote calls via .remote() or .submit(). Can also parse CLI arguments (example).
  • The desired remote Python environment (version and dependencies) is specified alongside your code via PEP 723 metadata. You don't manage any remote state.
# /// script
# requires-python = ">=3.12,<3.13"
# dependencies = [
#     numpy,
# ]
#
# [tool.hog.tutorial]  # Globus Compute Tutorial Endpoint
# endpoint = "4b116d3c-1703-4f8f-9f6f-39921e5864df"
#
# ///

import groundhog_hpc as hog

@hog.function(endpoint='tutorial') # points to [tool.hog.tutorial] config
def compute(x: int) -> int:
    import numpy as np
    return int(np.sum(range(x)))

@hog.harness()
def main():
    result = compute.remote(100)
    print(result)

Run with: hog run myscript.py main


see also: examples

Project details


Download files

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

Source Distribution

groundhog_hpc-0.8.0.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

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

groundhog_hpc-0.8.0-py3-none-any.whl (54.9 kB view details)

Uploaded Python 3

File details

Details for the file groundhog_hpc-0.8.0.tar.gz.

File metadata

  • Download URL: groundhog_hpc-0.8.0.tar.gz
  • Upload date:
  • Size: 40.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for groundhog_hpc-0.8.0.tar.gz
Algorithm Hash digest
SHA256 82fa21c5fe1c2935de75296f27c2ad1d20ee3722a6ff27987c610a527eaf698e
MD5 b5ce8cbaea4f4ab46ce1b0504297d8c4
BLAKE2b-256 49860ad692b0a80ac679b22e416c4f56e2ecc7e8d220bdc676df0e41b674925c

See more details on using hashes here.

File details

Details for the file groundhog_hpc-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: groundhog_hpc-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 54.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for groundhog_hpc-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb36aa4e46cea8e40aebd808cd4ce782024b158d57ec45afe3568f7216c34180
MD5 c727d8751b59f5975d9af3802a602771
BLAKE2b-256 0ca1d02e47ac7e7680eff679ecfb868d0c0ecb9834a2d9de20294ff668b4ccff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page