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: docs and 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.9.1.tar.gz (42.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.9.1-py3-none-any.whl (57.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: groundhog_hpc-0.9.1.tar.gz
  • Upload date:
  • Size: 42.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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.9.1.tar.gz
Algorithm Hash digest
SHA256 345fd07910f4a1bdc33b69d75a368755f780299d5822d1e9b209abc5b8b209be
MD5 fded2d15fa69400d1f378ecdc76dbff9
BLAKE2b-256 9d71e091bce972d4bd0dd16f5ec627ff95850a35439edb7b58628663af0a20d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: groundhog_hpc-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 57.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 227baabcdaaee893339b88a844337f632c6e502b7f735d695b91d082666da59f
MD5 e9bd9c0397c202bdefba161d138c7224
BLAKE2b-256 972e3f54333932099cf4fe564f10777cf4ba6cc1f4c1960733058b36fa787b48

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