Skip to main content

Scientific Compute Container Spec Parser

Project description

About

KLIKO is a specification, validator and parser for the KLIKO Scientific Compute Container specification. It enables a developer of scientific software to structure the input, output and parameters of a dockerized compute task. KLIKO is written in Python.

Installation

You can install Kliko inside a docker container or just on your system:

$ python setup.py install

or from pypi:

$ pip install kliko

Usage

from a Python script inside a container:

from kliko.validate import validate
parameters = validate()

or to check if a kliko file has a valid syntax:

$ kliko-validate /kliko.yml

or try to run the docker image from the examples folder directly:

$ kliko-run kliko/minimal --help

    usage: kliko-run [-h] [--target_folder TARGET_FOLDER] --choice {second,first}
                     --char CHAR [--float FLOAT] --file FILE --int INT
                     image_name

    positional arguments:
      image_name

    optional arguments:
      -h, --help            show this help message and exit
      --target_folder TARGET_FOLDER
      --choice {second,first}
                            choice field (default: second)
      --char CHAR           char field, maximum of 10 chars (default: empty)
      --float FLOAT         float field (default: 0.0)
      --file FILE           file field, this file will be put in /input in case of
                            split io, /work in case of join io
      --int INT             int field

Documentation

The documentation can be found on http://kliko.readthedocs.org

Example

There are examples of a kliko and parameters file in the examples folder.

Travis build status

https://img.shields.io/travis/gijzelaerr/kliko.svg https://img.shields.io/coveralls/gijzelaerr/kliko.svg https://img.shields.io/pypi/v/kliko.svg https://img.shields.io/pypi/pyversions/kliko.svg

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kliko-0.8.tar.gz (11.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page