GSOC: Add CWL support to Taverna
The proposed GSOC task is to add support for Common Workflow Language (CWL) in Apache Taverna (incubating).
The Apache Taverna community believe CWL support can be added to Taverna in a progressive fashion, and therefore the GSOC student can achieve success in multiple ways - and depending on her/his interests and existing skills can choose to pursue one or two of these tasks in detail, and if time permits can "top up" by exploring some of the remaining tasks more briefly as prototypes.
See the underlying Jira issues for further ideas.
- Save Taverna workflows as CWL (TAVERNA-881) - basically generate YAML by inspecting workflows using the Taverna Language API and follow the CWL specifications.
- Read CWL workflows (TAVERNA-877) - Add a plugin to Taverna Language API to parse CWL's YAML
- Execute CWL tool descriptions (TAVERNA-878) - modify Taverna's Tool activity
Browse and use CWL tool descriptions from the workbench ( TAVERNA-880) - modify GUI plugin to select from a collection or registry of tool descriptions Create a Docker tool for executing Taverna activities ( TAVERNA-879) - this allows any Taverna steps to be used by other CWL engines
Other Taverna or CWL-related tasks can of course also be proposed by the students.
The Common Workflow Language (CWL) is a pragmatic approach to a standardized workflow language for executing command line tools on the cloud and on local servers.
CWL is a YAML-based dataflow format, describing how command line tools can be wired together in a pipeline. An example workflow: https://github.com/common-workflow-language/workflows/blob/master/workflows/FestivalDemo/filtercount.cwl.yaml
CWL has a vibrant community and multiple implementations, including Rabix, Galaxy and a Python-based reference implementation cwltool.
Apache Taverna (incubating) is a Java-based workflow system with a graphical design interface. Taverna workflows can combine many different service types, including REST and WSDL services, command line tools, scripts (e.g. BeanShell, R) and custom plugins (e.g. BioMart).
Taverna workflows can be executed on the desktop, on the command line, or on a Taverna server installation, which can be controlled from a web portal, a mobile app, or integrated into third-party applications.
Taverna is used in a wide range of sciences for data analysis and processing, including bioinformatics, cheminformatics, biodiversity and musicology. Workflow engine features include provenance tracking, implicit parallelism/iterations, retry/failover and looping.
Taverna workflows are commonly shared on myExperiment, and can either be created graphically in the Taverna workbench, programmatically using the Taverna Language API or by generating workflow definitions in the SCUFL2 format.
Interested GSOC students are requested to engage early with the dev@taverna mailing list to describe their ideas for approaching this project, to clarify the tasks and for any questions and issues.
As a first step, the prospective applicant should leave a comment on this Jira issue to indicate their interest, and the GSOC mentors would be happy to assist on any questions.
As the project starts we are expecting the student to become part of the dev@taverna community to regularly discuss their progress.
We are also hoping the student would engage with the CWL community - particularly for questions on interpreting the CWL specifications and possibly even improving them. This engagement might include participating in development of the CWL Java SDK - although for GSOC evaluation purposes we will concentrate on your direct contributions to Apache Taverna.
An important part of GSOC is the personal mentoring from existing members of the open source community. Our job is not just to teach you how to successfully get through the GSOC programme, but also to motivate you and make sure you progress. We will show you how to contribute to open source, debug, improve, document, test and release your code as part of Apache Taverna.
The GSOC mentors for Apache Taverna have experience from guiding multiple earlier GSOC students and local students, and can be contacted privately for day-to-day interaction and trouble-shooting.
Mentors for this GSOC project:
- Stian Soiland-Reyes
TAVERNA-938 Run cwlrunner (nested CWL workflows)
- To Do
TAVERNA-880 Browse+use CWL tool descriptions
TAVERNA-879 Docker command line tool for Taverna Activity
TAVERNA-877 Parser for Common Workflow Language workflows
- To Do
TAVERNA-878 Tool: Execute CWL Tool descriptions
- To Do
TAVERNA-881 Save Taverna workflows as CWL
- To Do
- mentioned in