Git Product home page Git Product logo

galaxy2cwl's Introduction

Convert Galaxy workflow files to (abstract) CWL

This is a standalone tool that creates CWL-abstract descriptions of Galaxy workflow runs or Galaxy workflow files (static files).

  • Usage:
galaxy2cwl INPUT_GALAXY_WORKFLOW(.ga/.yaml) > OUTPUT_WORKFLOW.cwl
  • The tool works with inputs in both format1 (json format .ga, currently the standard for Galaxy workflow definitions) and format2. As described in the implementation (https://github.com/galaxyproject/gxformat2), gxformat2 is 'a highly experimental format and will change rapidly in potentially backward incompatible ways until the code is merged into the Galaxy server and enabled by default' therefore the conversion to CWL from this format is also variable and can rapidly change and/or break.
  • Initially the output of this project a CWL-abstract definition (aka cwl-interface, see common-workflow-language/common-workflow-language#337 and common-workflow-language/cwl-v1.2#3). As the CWL support in Galaxy increases then conversion could come up with a full CWL workflow file.

License

  • Copyright © 2019-2020, Ignacio Eguinoa, VIB, Universiteit Gent, and workflowhub.eu contributors

Distributed under a BSD 3-Clause license.

Installing from source

Easiest is to use pip:

pip3 install .

or, assuming all dependencies are installed:

python setup.py install

This should install cwl2galaxy on your PATH.

Alternatively you can run python3 galaxy2cwl/get_cwl_interface.py directly.

Examples

A simple workflow to use as example can be found in https://usegalaxy.eu/u/igegu/w/simple-workflow

This workflow is available in different formats in the examples/ directory of the source repository.

  • The Galaxy .ga format is in examples/simple_workflow_galaxy.ga
  • The format2 version yaml wrapped in json can be found in examples/simple_workflow_format2_yaml_wrapped.json
  • The format2 pure yaml in examples/simple_workflow_format2.yaml
  • The resulting CWL-interface can be found in examples/simple_workflow_cwl-interface.cwl

Packaging with RO-Crate

The objects created with this project are aimed to be part of workflow based RO-Crate packages for registering in WorkflowHub.

WorkflowHub is a project under development that aims at, among other things, serve as a repository for workflows standardizing the metadata description.

As such it provides the possibility of registering workflows in a diverse set of formats and packaging them in a RO-Crate package.

All examples included in this project are readily available in https://dev.workflowhub.eu/

Contribute

Contributions welcome! Raise pull requests, issues etc on https://github.com/workflowhub-eu/galaxy2cwl/.

Submitted patches are assumed to be licensed under the same BSD 3-Clause license.

galaxy2cwl's People

Contributors

ieguinoa avatar stain avatar mr-c avatar

Watchers

James Cloos 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.