kliko 0.2

About

KLIKO is a sSpecification, validator and parser for the Scientific Compute Container specification. KLIKO is written in Python.

Installation

$ python setup.py install

or:

$ pip install kliko

Usage

import kliko.validate
kliko.validate.validate(your_metadata_definition)

The specification

• All is based on standard docker containers

• Container mush have a CMD specified, which would be the main program of the container. It should not require arguments.

• logging should be written to STDOUT and STDERR.

• We define two types of compute containers, split IO and joined IO containers.

• For split IO Input files will be mounted read only into /input. Output file should be written to /output, which will be mounted by the host.

• For joined IO containers input & output is the /work folder which will be mounted RW.

• parameters can be defined with a file in json format called parameters.json in /input

• Which parameters the container will aceept should be defined in a yaml file /param_spec.yml

• The parameters definition (param_spec.yml) file should follow the schema defined in kliko/schema.yml.

• an example parameters definition file can be found in examples/form.yml

• fields with type file will enable supply of custom input files. these will be put in the /input folder.

• The container script should validate the supplied schema

Example

There is an example in examples/form.yml

Django

In kliko.django_form there is a function that can automatically generate a Django form from a parsed parameter definition file. This is used by RODRIGUES to render a form inside a website which then can be used to schedule a parameterized container.

https://github.com/ska-sa/rodrigues/

This requires django-form-utils.

https://pypi-hypernode.com/pypi/django-form-utils

Travis build status