diff --git a/README.md b/README.md index 8957c7f9..83090a29 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ Documentation is available here: https://janis.readthedocs.io/ Janis gives you an API to build computational workflows and will generate -a workflow description in CWL and WDL. By using Janis, you get type-safety, -portability and reproducibility across all of your execution environments. +a workflow description in CWL (v1.2) and WDL (version development). By using Janis, +you get type-safety, portability and reproducibility across all of your execution environments. Janis requires a Python installation > 3.6, and can be installed through PIP diff --git a/docs/index.rst b/docs/index.rst index c6585295..a8b6a870 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,8 +54,8 @@ Janis requires a Python installation > 3.6, and can be installed through PIP There are two ways to use Janis: -- Build workflows (and translate to CWL / WDL) -- Run tools or workflows with CWLTool or Cromwell +- Build workflows (and translate to CWL (v1.2) / WDL (version development) / Nextflow (in-progress)) +- Run tools or workflows with CWLTool, Cromwell, or Nextflow (in progress) Example Workflow diff --git a/docs/references/faq.md b/docs/references/faq.md index 2d9a7c1d..abb9c501 100644 --- a/docs/references/faq.md +++ b/docs/references/faq.md @@ -47,7 +47,7 @@ If you're still having trouble, use `janis spider --trace mytool` to give you an - **Can a `janis.ToolInput` be marked as streamable?** Currently there's no support to mark ToolInput's as `streamable`. Although the - [`CWL specification`](https://www.commonwl.org/v1.1/CommandLineTool.html#CommandInputParameter). + [`CWL specification`](https://www.commonwl.org/v1.2/CommandLineTool.html#CommandInputParameter). does support marking inputs as streamable, WDL does not and, there is [no engine support](https://github.com/broadinstitute/cromwell/issues/3454#issuecomment-455367417). @@ -150,4 +150,4 @@ If you're still having trouble, use `janis spider --trace mytool` to give you an You can override the container being used by specifying a `container-override`, there are two ways to do this: - CLI with the syntax: `janis [translate|run] --container-override 'MyTool=myorganisation/mytool:0.10.0' mytool` - - API: include container override dictionary: `mytool.translate("wdl", container_override={"mytool": "myorganisation/mytool:0.10.0"})`, the dictionary has structure: `{toolId: container}`. The toolId can be an asterisk `*` to override all tools' containers. \ No newline at end of file + - API: include container override dictionary: `mytool.translate("wdl", container_override={"mytool": "myorganisation/mytool:0.10.0"})`, the dictionary has structure: `{toolId: container}`. The toolId can be an asterisk `*` to override all tools' containers.