A python package that enables user to build their custom singularity image on HPC cluster
Project description
Building a singular container for HPC using globus-compute
Context
-
One of the executions configurations of globus compute requires a registered container which is spun up to execute the function on the HPC.
-
HPCs do not run docker containers and support only an apptainer/singularity image.
-
Installing the apptainer setup to build the singularity image locally is not a straightforward process especially on windows and mac systems.
A python package that enables user to build their custom singularity image on HPC cluster Using the python library the user can specify their custom image specification to build an apptainer/singularity image which would be used to run in-turn to run their functions on globus-compute. The library registers the container and returns the container id which would be used by the globus-compute executor to execute the function.
Prerequisite.
A globus-compute endpoint setup on HPC cluster.
Example
Consider the following use-case where the user wants to execute an expensive pandas operation. They need a singularity image which would be used by the globus-compute executor. The library can be leveraged as follows
from custom_image_builder import build_and_register_container
tutorial_endpoint = "01e21ddf-6eb4-41db-8e1d-2bcfe0c8314f"
container_id = build_and_register_container(endpoint_id=tutorial_endpoint,
image_file_name="my-test-image",
base_image_type="docker",
base_image="python:3.8",
pip_packages=["pandas"])
print("Container id ", container_id)
from globus_compute_sdk import Executor
def transform():
import pandas as pd
data = {
'City': ['New York', 'San Francisco', 'Los Angeles']
}
# Create a DataFrame from the dictionary
return pd.DataFrame(data)
with Executor(endpoint_id=tutorial_endpoint,
container_id=container_id) as ex:
fut = ex.submit(transform)
print(fut.result())
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
Built Distribution
File details
Details for the file custom_image_builder-0.1.1.tar.gz
.
File metadata
- Download URL: custom_image_builder-0.1.1.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.8.11 Darwin/22.3.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef89706af71552adf5de04451e4ce971e2a073f8ea1b63c6c99c3507c0b0e195 |
|
MD5 | 31d88fc54097a8031b8dd18fcba420a9 |
|
BLAKE2b-256 | 49230be835695e8af873a368f7bfa059cb702c4ebdf1278e99aff8898e7d81be |
File details
Details for the file custom_image_builder-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: custom_image_builder-0.1.1-py3-none-any.whl
- Upload date:
- Size: 4.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.8.11 Darwin/22.3.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 748a42b184343d907697b40ac6554186c80bba5d149c87d76eada2c1b94bdc6c |
|
MD5 | dcdbd5181900514db14fad4ae3094255 |
|
BLAKE2b-256 | 83ccde1ac0db68aa11e5c3ec7f02b50764ae5f660d921245c5b04d12b1fafe34 |