The Software Description Ontology

Parameter that can be adjusted in a configuration setup

Property that links parameter with the variable they adjust. This property can be used when parameters quantify variables without directly representing them. For example, a "fertilizer percentage adjustment" parameter can quantify a "fertilizer price" variable

The creator of a software component

Property that links a software component to other useful software that canbe used to visualize its outputs

Contributor to a software component

Copyright holder for a software component

Link to the organization funding a software component

Property to identify the original source of the information of the annotated resource. It could be a web page, an organization, a person, some experiment notes, etc.

Property that links a model to one of its configurations. A model may have multiple configurations, each of which is unique in terms of the inputs and outputs it uses.

Constraint or rule associated to a variable or software configuration. For example: "This model accepts only monthly data", or "all inputs of this model configuration must share the same location". More structured restrictions, such as Jena rules or SWRL rules may also be captured with this property

Contact person responsible for a software component

Property that associates an input/output with their corresponding data transformation.

Property to link an input/output dataset to the specific data transformation (with URLs

Relates a dataset specification to the data structure definition

Property that links a parameter or an input to a fixed value. For example, in a given configuration a parameter with the planting date for a model could be fixed to avoid the user changing it for that region.

Property that links a software project to its funding information

Property that links a model configuration to the input types expected by it.

Property that expresses what are the outputs of a model

Property that indicates the parameters of a model configuration

Property designed to reference the elements included in a sample collection.

Property that links an instance of a dataset (or a dataset specification) to the presentation of a variable contained (or expected to be contained) on it.

Property pointing to a sample execution of a software configuration

Property designed to link a software configuration to a sample resource resulting from its execution

A typical sample visualization of the software outputs

Property used to define configurations with some fixed resources and values. The rationale of this property is to allow predefined configurations

Function to link a function with its corresponding container

Property designed to link a software with its software source code (which may reside in a code repository such as GitHub)

the standard name of a variable

Property that links a rule and the variable that will test it

Property designed to link a software component with its corresponding versions

Property that links a dataset specification from a model configuration or setup to the output from a target data transformation. This occurs when a data transformation produces several outputs, but only one of them is the one needed for a model

Property that links to the image used as logo for a software component

Associates a presentation with a dataset where the presentation occurs

Publisher organization or person responsible for a software component

Image illustrating a snapshot of the target software

Property that indicates that a software component (or any of its outputs) can be used to calculate a particular index. The rationale for this property is that indices are usually calculated by applying post-processing steps to the outputs of a software component.

Property used to link a variable presentation or time interval to the unit they are represented in

Property that links a setup to a previous version of that setup. This property is needed (for example) when creating snapshots of setups.

Property that identifies the software used to create a visualization

Property that indicates in which registry the software image being described can be found. For example, https://hub.docker.com

How to cite this software

URL to the code repository of a software component

Year in which the software component was copyrighted

An identifier for resources with metadata entries in a data catalog

Date when a software component was created

Date when a software component was published

A description of a resource

Digital Object Identifier associated with a software component

Email of a person

Grant number used for funding

Property that constraints which values are accepted for a parameter. For example, the name of a crop can only be "Maize" or "Sorghum"

String with the people, organizations and other contributors acknowledged by the authors.

Assumptions of a software, e.g. the solver being used for a particular model, the source of the data (e.g., all data must have a given resolution), etc.

A file (e.g., Dockerfile) with executable instructions indicating how a Software Image or a Software component is built

Property linking the software component to the code of conduct to be followed by potential contributors. The range of this property may be a strin or a URI to the target file.

Location of the aggregation of all the files needed to execute the component. Usually a zip file including the run script and support scripts, including specification files

Property that indicates the data type of a parameter

Default accepted value of a variable presentation (or a parameter)

Property to indicate dimensionality of the input or output of a dataset specification

Pointer to the documentation of the model

Instructions needed to download a software component. The difference with hasDownloadURL is that this property captures the human readable instructions required to download software. For example, sometimes an authentication is needed, users need to fill in a form, etc.

Download URL where to obtain the source/executable of the software

An example explaining a scenario where the software component was used in plain language.

Instructions that indicate how a software component should be executed. The difference with hasExecutionCommand is that the execution instructions aim to be human-readable, and have explanations between the different commands and instructions

Property that links a software component with an executable notebook (e.g., Jupyter notebook) that illustrates how to use it in an executable manner.

Execution instructions on how to run the image

Frequently asked questions about a software

Value of a parameter in a software setup.

Format followed by a file. For example, txt, nc, etc.

Property that points to the main runnable script for the current function

Instructions required to install this particular piece of software. Installation instructions usually are available in a human-readable manner.

Properties that relate the variable representation to its long name. The long name is useful for context (e.g., precipitation is less ambiguous than P) but not as precise as the standard name.

Maximum accepted value of a variable presentation (or a parameter)

Minimum accepted value of a variable presentation (or a parameter)

Objective or main functionality that can be achieved by running this software

Rule that defines this constraint

A short name (e.g., temperature) capturing the high-level concept of the variable

Property that determines what are the increments (step size) that are commonly used to vary a parameter. This is commonly used for automatically setting up software tests. For example, if I want to set up a model and try 30 reasonable values on a parameter, I may use the default value and the step size to create the appropriate increments. If the step size is 0.1 and the default value is 0, then I will will be able to create setups: 0, 0.1, 0.2...2.9,3

Property that links to the location of scripts that may be used from the main runnable script.

Typical data sources that are used by a software component

Property that describes the usage considerations of a particular software. These notes capture the rationale of for that software configuration, along with an explanation for sample inputs, things to consider when running the model with data, etc.

Identifier of the version of this software

Identifier of the resource being described

Pointer to the issue tracker of a software component

Keywords associated with a software component

License of a software component or its source code

Memory requirements of a software

Name of the resource

Operating systems under which a software component can operate

Property that indicates the relative path of an input or output with respect to the folder structure of the executable.

For example, let's assume we have an input that has to exist in the folder /datasets or the executable will not work. This property ensures that this knowledge is captured for a given software component execution.

In this case the property would capture this as follows:

:input_prep a sd:DatasetSpecification . :input_prep rdfs:label "precipitation file" . :input_precip sd:pathLocation "/datasets/".

Position of the parameter or input/output in the model configuration. This property is needed to know how to organize the I/O of the component on execution

Processor requirements of a software component

Language used to code a software component

URl to the readme file of a software component

Value that represents how a parameter should be incremented on each iteration of a software component execution. This value is important when preparing execution ensembles automatically, e.g., simulating crop production varying the parameter "fertilizer amount" in increments of 10%.

Main publication to cite for this software component

A summarized description of the resource

Software requirements needed to install a software component

Data property to indicate the status of a configuration setups. For example, to indicate that a setup has been executed in a platform, that the setup should notbe shown to users (it's an auxiliary setup), etc.

Property to link details, such as mailing lists in case a contact person is not provided

Tag used to annotate a version or a software configuration. This annotation is useful to show which version is the latest, or which version is deprecated. Supported tags are: "latest", "deprecated"

Value associated to the described entity

Website of the software