You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The name of the executable within a certain run-time context (e.g. an
60
-
executable filename or name of an importable module). This documents on a
61
-
fairly high level by what name software is invoked from a certain run-time
62
-
context. The run-time context itself is turn loosely determined by properties
63
-
such as ``schema:runtimePlatform`` and ``schema:operatingSystem``.
59
+
The base filename of the executable for the software application. It should not
60
+
be a full path, nor should it contain any command-line parameters.
64
61
65
62
We include this property to make a clear distinction between the human readable
66
-
name of the software, and the identifier used in invocation of the software.
63
+
name of the software, and the executable used in invocation of the software.
67
64
The two may regularly differ with one being more verbose or have stricter
68
65
casing than the other.
69
66
70
-
Examples for this property are:
71
-
72
-
* The name of the invoked executable as invoked from the command line
73
-
* The name of the library as used in the linking stage for compiled languages
74
-
* The highest-level name of the module as invoked in an ``import`` or ``include`` statement in languages such as Python, R, Perl, Java.
75
-
* The name of the package as passed to a certain package manager (for ``SoftwarePackage``)
76
-
* The name of the container as known to a certain container registry (for ``SoftwareImage``)
77
-
78
67
Examples of this property are also shown in the code snippets A and B.
79
68
80
-
Note that the executable name should typically not contain any
81
-
platform/runtime-specific extensions which may differ across systems
82
-
(``.exe``,``.so``,``.dll``,``.dylib``). However, such extensions may be
83
-
included if they are static over all possible systems and needed to invoke the
84
-
software (``.jar``,``.sh``) and a necessary component in invoking the software
85
-
from a specific context.
69
+
It's recommended to either leave out any platform-specific extensions like
70
+
``.exe`` if the executable differs across platforms, or to simply use the
71
+
property multiple times to list all possible variants.
86
72
87
73
## How are software types terms used with codemeta?
88
74
@@ -118,7 +104,6 @@ Example A (JSON-LD): An application named [WIDOCO](https://github.com/dgarijo/Wi
118
104
},
119
105
{
120
106
"type": "SoftwareLibrary",
121
-
"executableName": "es.oeg.Widoco",
122
107
"name": "WIDOCO",
123
108
"runtimePlatform": "Linux"
124
109
},
@@ -204,6 +189,16 @@ implemented in the following software:
204
189
205
190
Many vocabularies exist to describe software or its constituent parts, e.g., the [software description ontology](https://w3id.org/okn/o/sd/), [description of a project vocabulary](http://usefulinc.com/ns/doap#), [hydra](https://www.hydra-cg.com/spec/latest/core/) (for API description), the common workflow language (description of inputs and outputs of software components, etc.), etc. Our proposed profile does not aim to redefine any new term related to software, but propose a lightweight profile that can be easily incorporated into schema.org or codemeta.
206
191
192
+
## Real Examples
193
+
194
+
You can consult the following projects as examples that make use of this profile:
Furthermore, the [CLARIAH Tools Portal](https://tools.dev.clariah.nl/) is build on the aforementioned implementations and may offer further examples of codemeta that also incorporates this software application type profile.
201
+
207
202
## Acknowledgement
208
203
209
204
This work was indirectly and partially funded through the [CLARIAH-PLUS project](https://clariah.nl).
0 commit comments