Skip to content

Commit

Permalink
requirements: mark closed issues
Browse files Browse the repository at this point in the history
  • Loading branch information
simleo committed Nov 24, 2023
1 parent ee5f8fc commit ab92971
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ title: Requirements for Workflow Run Crate

id | CQ description | Existing/new terms | Rationale | Profile[^1] | Issue # |
| -- | -- | -- | -- | -- | -- |
CQ1 | What container images (e.g., Docker) were used by the run? | Overload [image](http://schema.org/image)? The type of the target entity can be `File` if the image is a tarball from `docker save` | To archive images before they disappear so workflow can run later in time | 1, 3 | [9](https://github.com/ResearchObject/workflow-run-crate/issues/9) |
CQ1 | What container images (e.g., Docker) were used by the run? | Overload [image](http://schema.org/image)? The type of the target entity can be `File` if the image is a tarball from `docker save` | To archive images before they disappear so workflow can run later in time | 1, 3 | [~~9~~](https://github.com/ResearchObject/workflow-run-crate/issues/9) |
CQ2 | How much memory/cpu/disk was used in run? | memory, disk, cpu, architecture, gpu (possibly [memoryRequirements](http://schema.org/memoryRequirements) [storageRequirements](http://schema.org/storageRequirements)) | To find the right hardware for running workflow | 1, 2, 3 | [10](https://github.com/ResearchObject/workflow-run-crate/issues/10) |
CQ3 | What are the configuration files used in a workflow execution step? | [ChooseAction](http://schema.org/ChooseAction)? Though maybe the crate generator should just merge the params with the other ones if it can parse the config file. To link to the config file as a black box instead we probably need a new property |For reproducibility purposes, the values/settings inside config files can have big impact on output | 1, 3 | [~~11~~](https://github.com/ResearchObject/workflow-run-crate/issues/11) |
CQ4 | What is the environment/container file used in a specific workflow execution step? | Similar to the configuration file problem. Need env dump support from workflow engine | Knowing the environment helps debugging and reproducing the setup | 1, 3 | [12](https://github.com/ResearchObject/workflow-run-crate/issues/12) |
Expand All @@ -29,7 +29,7 @@ id | CQ description | Existing/new terms | Rationale | Profile[^1] | Issue # |
CQ7 | Was the execution successful? | [actionStatus](http://schema.org/actionStatus) to [FailedActionStatus](http://schema.org/FailedActionStatus) or [CompletedActionStatus](http://schema.org/CompletedActionStatus) - can also provide [error](http://schema.org/error) | Needed to know whether or not retrieve the results | 1, 2, 3 | [~~15~~](https://github.com/ResearchObject/workflow-run-crate/issues/15) |
CQ8 | What are the inputs and outputs of the overall workflow (I don't care about the intermediate results) | [object](http://schema.org/object) and [result](http://schema.org/result) on the workflow run action | High level representation of the workflow execution | 2, 3 | [~~16~~](https://github.com/ResearchObject/workflow-run-crate/issues/16) |
CQ9 | What is the source code version of the component executed in a workflow step? Is it a script? and executable? | [softwareVersion](http://schema.org/softwareVersion), though getting the version of the actual tool (e.g., `grep`) that was called by the wrapper might not be easy | Knowing which release/software version was used (reproducibility) | 1, 3 | [~~17~~](https://github.com/ResearchObject/workflow-run-crate/issues/17) |
CQ10 | What is the script used to wrap up a software component? | We're mapping tool wrappers (e.g., `foo.cwl`) to [SoftwareApplication](http://schema.org/SoftwareApplication). Wrappers at lower levels can also be `SoftwareApplication`, but we need to draw the line somewhere | Many executables are complicated, and need an additional script to wrap them up or simplify. For example a "run.sh" script that exposes a simpler set of parameters and fixes another set. | 3 | [18](https://github.com/ResearchObject/workflow-run-crate/issues/18) |
CQ10 | What is the script used to wrap up a software component? | We're mapping tool wrappers (e.g., `foo.cwl`) to [SoftwareApplication](http://schema.org/SoftwareApplication). Wrappers at lower levels can also be `SoftwareApplication`, but we need to draw the line somewhere | Many executables are complicated, and need an additional script to wrap them up or simplify. For example a "run.sh" script that exposes a simpler set of parameters and fixes another set. | 3 | [~~18~~](https://github.com/ResearchObject/workflow-run-crate/issues/18) |
CQ11 | How were workflow parameters used in tool runs? | We're linking tool params directly (with [connectedTo](http://schema.org/connectedTo)), but that's inaccurate since those links only exist within a workflow. | Knowing how workflow parameters were passed to individual tools to find out how they affected the outputs | 3 | [~~25~~](https://github.com/ResearchObject/workflow-run-crate/issues/25) |

[^1]: 1: [Process Run Crate](process_run_crate); 2: [Workflow Run Crate](workflow_run_crate); 3: [Provenance Run Crate](provenance_run_crate).

0 comments on commit ab92971

Please sign in to comment.