A Python package to run containers on HPC systems
Project description
Kunefe
Kunefe is a Python package that helps users run Docker containers on HPC systems. It can:
- convert an existing Docker image into an Apptainer image
- generate scripts for batch jobs to run containerized images
- submit jobs to HPC batch queues (SLURM)
- connect to a remote host via SSH and run commands
- copy and retrieve files from a remote system
- monitor the job queue
Requirements
The host system requirements (e.g. your laptop or desktop computer):
Remote system requirements:
Note: If Apptainer is not available on the remote system, it can be installed using kunefe which will require the following packages to be installed on the remote system: curl rpm2cpio cpio
Badges
fair-software.eu recommendations | |
---|---|
howfairis | |
(1/5) code repository | |
(2/5) license | |
(3/5) community registry | |
(4/5) citation | |
(5/5) checklist |
🚀 Click to see all the badges
Code quality | |
---|---|
Static analysis | |
Coverage |
GitHub Actions | |
---|---|
Build | |
Howfairis | |
Citation data consistency | |
SonarCloud | |
MarkDown link checker |
Installation
To install the latest kunefe release from PyPI, run:
python -m pip install kunefe
To install the development version of kunefe from GitHub repository, do:
python -m pip install git+https://github.com/mess-nlesc/kunefe.git@main
Examples
See the examples in examples
folder.
Documentation
See https://readthedocs.org/projects/kunefe/ for the code documentation.
The project setup
The project setup is documented in project_setup.md. Feel free to remove this document (and/or the link to this document) if you don't need it.
Contributing
If you want to contribute to the development of kunefe, have a look at the contribution guidelines.
Credits
This package was created with Cookiecutter and the NLeSC/python-template.
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 kunefe-0.5.1.tar.gz
.
File metadata
- Download URL: kunefe-0.5.1.tar.gz
- Upload date:
- Size: 39.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9dd111d595c5bca34a4202e7648712a39d3141d7310da4399b27caca5a963b2 |
|
MD5 | a38833b95f77c04eab7ce3e50dab7574 |
|
BLAKE2b-256 | c33c217bce2ccb2860a3517effdc18171d2a92d7ba3b92718dd468136351d577 |
File details
Details for the file kunefe-0.5.1-py3-none-any.whl
.
File metadata
- Download URL: kunefe-0.5.1-py3-none-any.whl
- Upload date:
- Size: 16.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0e389b1f4eb14a3ca640840401f078dca6f4614eadf075153c08bbcad46d30c |
|
MD5 | e657854624f3d25efa39e785150f038e |
|
BLAKE2b-256 | 5e0bb12acab0e38011953cd559be9ad3cd5bf95abf48cc2f250311742da7ddb4 |