Skip to content

Commit

Permalink
Merge pull request #57 from PMCC-BioinformaticsCore/add-version-info
Browse files Browse the repository at this point in the history
Add CWL / WDL version info to Janis
  • Loading branch information
illusional authored Sep 1, 2021
2 parents 7709c4b + 4aadc28 commit 7256865
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/references/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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.
- 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.

0 comments on commit 7256865

Please sign in to comment.