A Python package to run containers on HPC systems
Project description
Kunefe
Kunefe is a Python package that helps users run containers on HPC systems. It can:
- convert Docker images into a Apptainer image
- generate scripts for batch jobs to run Docker 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
Requirements
Badges
| General | |
|---|---|
| Supported Python versions |  |
| Supported Operating systems |  |
| Code quality | |
|---|---|
| Static analysis |          |
| Coverage |  |
| Documentation |  |
| Tests |  |
| GitHub Actions | |
|---|---|
| Build |  |
| Howfairis |  |
| Citation data consistency |  |
| SonarCloud |  |
| MarkDown link checker |  |
| fair-software.eu recommendations | |
|---|---|
| howfairis |  |
| (1/5) code repository |  |
| (2/5) license |  |
| (3/5) community registry |   |
| (4/5) citation |  |
| (5/5) checklist |  |
Installation
To install the latest kunefe release from PyPI, run:
python -m pip kunefe
To install the development version of kunefe from GitHub repository, do:
git clone git@github.com:mess-nlesc/kunefe.git
cd kunefe
python -m pip install .
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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
