Skip to content

Commit 03519b9

Browse files
stainstain
committed
Define buildInstructions in profile
.. as it's not in RO-Crate 1.1
1 parent 7b866ff commit 03519b9

File tree

3 files changed

+76
-2
lines changed

3 files changed

+76
-2
lines changed

‎docs/profiles/0.5-DRAFT/provenance_run_crate/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ In some workflow systems (e.g., CWL, Galaxy), tools are typically wrappers for a
468468

469469
## Tool runtime environment
470470

471-
While the `softwareRequirements` of a tool can [specify software dependencies](process_run_crate#specifying-software-dependencies) (as above) in terms of naming software, a more reproducible definition of a tool's runtime environment may need to include a particular set of binaries that are compiled and/or distributed to work together.
471+
While the `softwareRequirements` of a tool can [specify software dependencies](process_run_crate#specifying-software-dependencies) (as above) in terms of naming software, a more reproducible definition of a tool's runtime environment may need to include a particular set of binaries that are compiled and/or distributed to work together. (Note that _runtime environment_ here refers to a set of software, configuration and other dependency files, not [environment variables](workflow_run_crate#environment-variables-as-formal-parameters)).
472472

473473
Some workflow engines support such package systems as a way to distribute tool dependencies, typically by referring to an _environment file_ which can be programmatically instansiated to retrieve and install a given set of binaries. In a Provenance Crate, environment files are indicated as `buildInstructions` for either the `HowToStep` (for a given step) or the `HowTo` (for the whole workflow).
474474

‎docs/profiles/0.5-DRAFT/provenance_run_crate/ro-crate-metadata.json‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@
4646
{ "@id": "https://w3id.org/ro/terms/workflow-run#ParameterConnection" },
4747
{ "@id": "https://w3id.org/ro/terms/workflow-run#connection" },
4848
{ "@id": "https://w3id.org/ro/terms/workflow-run#sourceParameter" },
49-
{ "@id": "https://w3id.org/ro/terms/workflow-run#targetParameter" }
49+
{ "@id": "https://w3id.org/ro/terms/workflow-run#targetParameter" },
50+
{ "@id": "https://codemeta.github.io/terms/buildInstructions" }
5051
],
5152
"hasResource": [
5253
{ "@id": "#hasSpecification" },
@@ -385,6 +386,21 @@
385386
"inDefinedTermSet": { "@id": "https://w3id.org/ro/terms/workflow-run#" },
386387
"description": "The target (upstream) parameter"
387388
},
389+
{
390+
"@id": "https://codemeta.github.io/terms/buildInstructions",
391+
"@type": "DefinedTerm",
392+
"name": "buildInstructions",
393+
"termCode": "buildInstructions",
394+
"description": "Build environment file (e.g. for Conda)",
395+
"inDefinedTermSet": { "@id": "https://codemeta.github.io/terms/" }
396+
},
397+
{
398+
"@id": "https://codemeta.github.io/terms/",
399+
"@type": "DefinedTermSet",
400+
"name": "Codemeta Terms",
401+
"url": "https://codemeta.github.io/terms/",
402+
"version": "3.0"
403+
},
388404
{
389405
"@id": "https://pypi.org/project/runcrate/",
390406
"@type": "SoftwareApplication",

‎docs/profiles/0.5-DRAFT/provenance_run_crate/ro-crate-preview.html‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,9 @@
8888
},
8989
{
9090
"@id": "https://w3id.org/ro/terms/workflow-run#targetParameter"
91+
},
92+
{
93+
"@id": "https://codemeta.github.io/terms/buildInstructions"
9194
}
9295
],
9396
"hasResource": [
@@ -426,6 +429,16 @@
426429
},
427430
"description": "The target (upstream) parameter"
428431
},
432+
{
433+
"@id": "https://codemeta.github.io/terms/buildInstructions",
434+
"@type": "DefinedTerm",
435+
"name": "buildInstructions",
436+
"termCode": "buildInstructions",
437+
"description": "Build environment file (e.g. for Conda)",
438+
"inDefinedTermSet": {
439+
"@id": "https://codemeta.github.io/terms/"
440+
}
441+
},
429442
{
430443
"@id": "#hasSpecification",
431444
"@type": "ResourceDescriptor",
@@ -841,6 +854,13 @@
841854
"@type": "Person",
842855
"name": "Salvador Capella-Gutierrez"
843856
},
857+
{
858+
"@id": "https://codemeta.github.io/terms/",
859+
"@type": "DefinedTermSet",
860+
"name": "Codemeta Terms",
861+
"url": "https://codemeta.github.io/terms/",
862+
"version": "3.0"
863+
},
844864
{
845865
"@id": "http://schema.org/MediaObject",
846866
"@type": "DefinedTerm",
@@ -970,6 +990,8 @@ <h3><a href="https://w3id.org/ro/wfrun/provenance/0.5-DRAFT">Go to: </a> Provena
970990
<li><a href="#https%3A//w3id.org/ro/terms/workflow-run%23sourceParameter">source parameter</a></li>
971991

972992
<li><a href="#https%3A//w3id.org/ro/terms/workflow-run%23targetParameter">target parameter</a></li>
993+
994+
<li><a href="#https%3A//codemeta.github.io/terms/buildInstructions">buildInstructions</a></li>
973995
</ul></td>
974996
</tr><tr>
975997
<th style="text-align:left;" class="prop">hasResource<span>&nbsp;</span><a href="http://www.w3.org/ns/dx/prof/hasResource">[?]</a></th>
@@ -1678,6 +1700,42 @@ <h3><a href="https://w3id.org/ro/terms/workflow-run#targetParameter">Go to: </a>
16781700
</table>
16791701
</div>
16801702

1703+
</div>
1704+
<hr/><br/><br/>
1705+
<div>
1706+
<h3><a href="https://codemeta.github.io/terms/buildInstructions">Go to: </a> buildInstructions</h3>
1707+
1708+
1709+
1710+
1711+
<div id="https://codemeta.github.io/terms/buildInstructions">
1712+
1713+
<table class="table metadata table-striped" >
1714+
<tbody><tr>
1715+
<th style="text-align:left;" class="prop">@id</th>
1716+
<td style='text-align:left'><a href="https://codemeta.github.io/terms/buildInstructions">https://codemeta.github.io/terms/buildInstructions</a></td>
1717+
</tr><tr>
1718+
<th style="text-align:left;" class="prop">name<span>&nbsp;</span><a href="http://schema.org/name">[?]</a></th>
1719+
<td style='text-align:left'><span>buildInstructions</span></td>
1720+
</tr><tr>
1721+
<th style="text-align:left;" class="prop">@type</th>
1722+
<td style='text-align:left'><span>DefinedTerm</span></td>
1723+
</tr><tr>
1724+
<th style="text-align:left;" class="prop">description<span>&nbsp;</span><a href="http://schema.org/description">[?]</a></th>
1725+
<td style='text-align:left'><span>Build environment file (e.g. for Conda)</span></td>
1726+
</tr><tr>
1727+
<th style="text-align:left;" class="prop">termCode<span>&nbsp;</span><a href="http://schema.org/termCode">[?]</a></th>
1728+
<td style='text-align:left'><span>buildInstructions</span></td>
1729+
</tr><tr>
1730+
<th style="text-align:left;" class="prop">inDefinedTermSet<span>&nbsp;</span><a href="http://schema.org/inDefinedTermSet">[?]</a></th>
1731+
<td style='text-align:left'><a href="#https%3A//codemeta.github.io/terms/">Codemeta Terms</a></td>
1732+
</tr><tr><th colspan="2" style="text-align:center">Items that reference this one</th><tr><tr>
1733+
<th style="text-align:left;" class="prop">hasPart<span>&nbsp;</span><a href="http://schema.org/hasPart">[?]</a></th>
1734+
<td style='text-align:left'><a href="#https%3A//w3id.org/ro/wfrun/provenance/0.5-DRAFT">Provenance Run Crate profile</a></td>
1735+
</tr></tbody>
1736+
</table>
1737+
</div>
1738+
16811739
</div>
16821740
<hr/><br/><br/>
16831741
<div>

0 commit comments

Comments
 (0)