Code Monkey home page Code Monkey logo

krews's Introduction

logo

Krews, short for "Kotlin Reactive Workflows" is a framework for creating scalable and reproducible scientific data pipelines using Docker Containers piped together with Project Reactor, a mature functional reactive programming library.

Workflows are written using a Kotlin DSL in plain old Kotlin projects, meaning you get all the benefits of a modern, type-safe, functional language with fantastic tooling.

Documentation

Full Documentation can be found here

Boilerplate

The fastest way to get started is to clone the krews-boilerplate. This is not only quick, but is set up using what we consider to be best practices.

The boilerplate README.md contains instructions on what you'll need to replace, as well as instructions on running and building.

Quick Example

fun main(args: Array<String>) = run(sampleWorkflow, args)

val sampleWorkflow = workflow("sample-workflow") {

    // Reactive "Flux" list object for the numbers 1 to 5
    val range = (1..5).toFlux()
    
    task<Int, File>("base64", range) {
        dockerImage = "alpine:3.9"
        output = OutputFile("base64/$input.b64")
        command =
            """
            mkdir -p /data/base64
            echo "Hello World $input!" | base64 > /data/base64/$input.b64
            """
    }
}

Configuration

working-dir = /data/sample-workflow

Run command

java -jar my-app.jar --on local --config path/to/my-config.conf

Supported Platforms

Installation

Gradle

dependencies {
    compile("io.krews", "krews", "0.10.10")
}

Maven

<dependency>
  <groupId>io.krews</groupId>
  <artifactId>krews</artifactId>
  <version>0.10.10</version>
</dependency>

krews's People

Contributors

hpratt avatar jackh726 avatar jsonbrooks avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.