Skip to main content

Software Environment

A computational environment.

This schema type is marked as experimental 🧪 and is subject to change.

Properties#

Name@idTypeDescriptionInherited from
nameschema:namestringThe name of the item.Thing
addsstencila:addsArray of SoftwareSourceCodeThe packages that this environment adds to the base environments listed under `extends` (if any).,SoftwareEnvironment
alternateNamesschema:alternateNameArray of stringAlternate names (aliases) for the item.Thing
descriptionschema:descriptionArray of BlockContent or Array of InlineContent or stringA description of the item. See note 1.Thing
extendsstencila:extendsArray of SoftwareEnvironmentOther environments that this environment extends by adding or removing packages.,SoftwareEnvironment
idschema:idstringThe identifier for this item.Entity
identifiersschema:identifierArray of (PropertyValue or string)Any kind of identifier for any kind of Thing. See note 2.Thing
imagesschema:imageArray of (ImageObject or Format 'uri')Images of the item.Thing
metastencila:metaobjectMetadata associated with this item.Entity
removesstencila:removesArray of SoftwareSourceCodeThe packages that this environment removes from the base environments listed under `extends` (if any).,SoftwareEnvironment
urlschema:urlFormat 'uri'The URL of the item.Thing

Notes#

  1. description : !array('Allows for the description to be an array of nodes (e.g. an array of inline content, or a couple of paragraphs), or a string. The ')minItems!array(' restriction avoids a string being coerced into an array with a single string item.')
  2. identifiers : !array('Some identifiers have specific properties e.g the ')issn!array(' property for the ')Periodical!array(' type. These should be used in preference to this property which is intended for identifiers that do not yet have a specific property. Identifiers can be represented as strings, but using a ')PropertyValue!array(' will usually be better because it allows for ')propertyID!array(' (i.e. the type of identifier).')

Related#

  • Parent: Thing
  • Descendants: None

Available as#

Source#

This documentation was generated from SoftwareEnvironment.schema.yaml.