search

common-workflow-language / user_guide

The CWL v1.0 - v1.2 user guide
http://www.commonwl.org/user_guide/
Other
42 stars 67 forks source link

No reference documentation for `cwltool:CUDARequirement` #414

Open fmigneault opened 1 year ago

fmigneault commented 1 year ago

There is no current definition in https://www.commonwl.org/v1.2/CommandLineTool.html for cwltool:CUDARequirement. Considering it is the "core" CWL specification, this is understandable.

However, it is mentioned in http://www.commonwl.org/user_guide/introduction/basic-concepts.html#processes-and-requirements and other tools have also added support for it:

It would be very helpful to have an official location where this is documented. It could be placed in an "extensions" section to highlight that it is not core CWL.

mr-c commented 1 year ago

Hello @fmigneault

I agree that proper documentation for extensions like this one are missing. https://github.com/common-workflow-language/common-workflow-language/issues/323 also talks about this

In addition to a rendered schema for the extensions, it would be good to have a list of which CWL implementstions support the extension and the standards track status (not-planned, planned-but-unscheduled, pending-cwl-v1.3, etc..)

fmigneault commented 1 year ago

Thanks to the discussion https://github.com/crim-ca/weaver/pull/506#discussion_r1037890712 and the pointer to https://github.com/common-workflow-language/cwltool/blob/main/cwltool/extensions-v1.2.yml, I found quite a lot of other useful requirements like Secrets that I was not even aware of their existence.

To help in new user adoption of available utilities, I think this documentation should be prioritized.