https://github.com/terradue/pycalrissian
Python client for Calrissian - CWL on kubernetes
https://github.com/terradue/pycalrissian
common-workflow-language cwl kubernetes python
Last synced: about 1 year ago
JSON representation
Python client for Calrissian - CWL on kubernetes
- Host: GitHub
- URL: https://github.com/terradue/pycalrissian
- Owner: Terradue
- Created: 2022-07-08T14:15:07.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T09:04:01.000Z (over 1 year ago)
- Last Synced: 2024-09-17T11:30:46.630Z (over 1 year ago)
- Topics: common-workflow-language, cwl, kubernetes, python
- Language: Python
- Homepage: https://terradue.github.io/pycalrissian/
- Size: 549 KB
- Stars: 2
- Watchers: 8
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pycalrissian
_pycalrissian_ is a Python client library for running Common Workflow Language (CWL) descriptions on Kubernetes using [Calrissian](https://github.com/Duke-GCB/calrissian).
It provides simple objects and methods to:
* prepare a Kubernetes namespace ready to run Calrissian kubernetes jobs.
* create a Calrissian Kubernetes job in that namespace based on a CWL description and its parameters
* submit and monitor the job execution and retrieve usage, logs and outputs
Refer to the [documentation](https://terradue.github.io/pycalrissian/) to get started.
## Development
Use the Visual Studio Code Remote Container configuration.
Requirements:
* in your local `$HOME` you must have a `.kube` folder as it is mounted on the development container to access the kubernetes cluster
**Kubernetes resources for development and testing**
We suggest using microk8s and set the kubeconfig with:
```
microk8s config > ~/.kube/config
```