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.2.tar.gz (42.1 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.2-py3-none-any.whl (57.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: groundhog_hpc-0.9.2.tar.gz
  • Upload date:
  • Size: 42.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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.2.tar.gz
Algorithm Hash digest
SHA256 4cdc60480ef8205be0b2f780ee9100e102053836e04c8634ed6751afc2e7fafd
MD5 ae8df8be7fe81886514e31595cd3c284
BLAKE2b-256 aebb311d30e0d6888e6f278eadf50cde9d44086dc7b83e3d7c90b9c41af4a653

See more details on using hashes here.

File details

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

File metadata

  • Download URL: groundhog_hpc-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 57.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 69e4d324fe2ed9a62640a346fcbfb52e14836f2fa6f8607a6c789523ba214860
MD5 cc46977f5665edabbd025a82bee8841f
BLAKE2b-256 3c6a39305971956a725d554b14b669b211f6f7e931e93670cbd4026ecab4fdf3

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