Class: SoftwareRequirement

An individual software requirement binding a package to a version constraint and a role within an environment.

URI: tvbo_sw:class/SoftwareRequirement

 classDiagram
    class SoftwareRequirement
    click SoftwareRequirement href "./SoftwareRequirement.html"
      SoftwareRequirement : dataLocation
        
          
    
        
        
        SoftwareRequirement --> "0..1" String : dataLocation
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      SoftwareRequirement : description
        
          
    
        
        
        SoftwareRequirement --> "0..1" String : description
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      SoftwareRequirement : hash
        
          
    
        
        
        SoftwareRequirement --> "0..1" String : hash
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      SoftwareRequirement : license
        
          
    
        
        
        SoftwareRequirement --> "0..1" String : license
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      SoftwareRequirement : modules
        
          
    
        
        
        SoftwareRequirement --> "*" String : modules
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      SoftwareRequirement : name
        
          
    
        
        
        SoftwareRequirement --> "1" String : name
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      SoftwareRequirement : optional
        
          
    
        
        
        SoftwareRequirement --> "0..1" Boolean : optional
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

        
      SoftwareRequirement : package
        
          
    
        
        
        SoftwareRequirement --> "0..1" SoftwarePackage : package
        click SoftwarePackage href "./SoftwarePackage.html"
    

        
      SoftwareRequirement : role
        
          
    
        
        
        SoftwareRequirement --> "0..1" RequirementRole : role
        click RequirementRole href "../../enums/RequirementRole.html"
    

        
      SoftwareRequirement : source_url
        
          
    
        
        
        SoftwareRequirement --> "0..1" String : source_url
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      SoftwareRequirement : url
        
          
    
        
        
        SoftwareRequirement --> "0..1" String : url
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      SoftwareRequirement : version
        
          
    
        
        
        SoftwareRequirement --> "0..1" String : version
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      SoftwareRequirement : version_spec
        
          
    
        
        
        SoftwareRequirement --> "0..1" String : version_spec
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"

Slots

Name Cardinality and Range Description Inheritance
name 0..1
xsd:string		 direct
description 0..1
xsd:string		 direct
dataLocation 0..1
xsd:string		 direct
package 0..1
SoftwarePackage		 Reference to the software package identity direct
version_spec 0..1
xsd:string		 Version or constraint specifier (e direct
role 0..1
RequirementRole		 direct
optional 0..1
xsd:boolean		 direct
hash 0..1
xsd:string		 Build or artifact hash for exact reproducibility direct
source_url 0..1
xsd:string		 Canonical source or repository URL direct
url 0..1
xsd:string		 (Deprecated) Use source_url direct
license 0..1
xsd:string		 direct
modules *
xsd:string		 (Deprecated) Use environment direct
version 0..1
xsd:string		 (Deprecated) Use version_spec direct

Usages

used by used in type used
SoftwareEnvironment requirements range SoftwareRequirement
Equation engine range SoftwareRequirement
TemporalApplicableEquation engine range SoftwareRequirement
Function requirements range SoftwareRequirement
LossFunction requirements range SoftwareRequirement
Callable software range SoftwareRequirement
ClassReference software range SoftwareRequirement
Continuation software range SoftwareRequirement
SimulationExperiment software range SoftwareRequirement
PDESolver requirements range SoftwareRequirement

Comments

  • Represents an individual requirement (package/module/library).
  • Use ‘version_spec’ instead of ‘version’ for semantic clarity.

Identifier and Mapping Information

Schema Source

  • from schema: https://w3id.org/tvbo/software

Mappings

Mapping Type Mapped Value
self tvbo_sw:SoftwareRequirement
native tvbo_sw:SoftwareRequirement

LinkML Source

Direct

name: SoftwareRequirement
description: An individual software requirement binding a package to a version constraint
  and a role within an environment.
comments:
- Represents an individual requirement (package/module/library).
- Use 'version_spec' instead of 'version' for semantic clarity.
from_schema: https://w3id.org/tvbo/software
attributes:
  name:
    name: name
    from_schema: https://w3id.org/tvbo/software
    key: true
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Event
    - Tractogram
    - GraphGenerator
    - File
    - StateValue
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - Algorithm
    - Option
    - BranchSwitch
    - Continuation
    - Coupling
    range: string
    required: true
  description:
    name: description
    from_schema: https://w3id.org/tvbo/software
    domain_of:
    - Dataset
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Equation
    - Stimulus
    - Event
    - Tractogram
    - Matrix
    - Network
    - GraphGenerator
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - TuningObjective
    - Algorithm
    - BranchSwitch
    - Continuation
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  dataLocation:
    name: dataLocation
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    domain_of:
    - ParcellationTerminology
    - SoftwareRequirement
    - SoftwareEnvironment
    - Stimulus
    - Matrix
    - RandomStream
    - RegionMapping
    - TimeSeries
    - NDArray
    - Mesh
    range: string
  package:
    name: package
    description: Reference to the software package identity.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    domain_of:
    - SoftwareRequirement
    range: SoftwarePackage
  version_spec:
    name: version_spec
    description: Version or constraint specifier (e.g., '==2.7.3', '>=1.2,<2').
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    domain_of:
    - SoftwareRequirement
    range: string
  role:
    name: role
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    ifabsent: runtime
    domain_of:
    - SoftwareRequirement
    range: RequirementRole
  optional:
    name: optional
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    ifabsent: 'False'
    domain_of:
    - SoftwareRequirement
    range: boolean
  hash:
    name: hash
    description: Build or artifact hash for exact reproducibility.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    domain_of:
    - SoftwareRequirement
    range: string
  source_url:
    name: source_url
    description: Canonical source or repository URL.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    domain_of:
    - SoftwareRequirement
    range: string
  url:
    name: url
    description: (Deprecated) Use source_url.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    domain_of:
    - SoftwareRequirement
    range: string
  license:
    name: license
    from_schema: https://w3id.org/tvbo/software
    domain_of:
    - CommonCoordinateSpace
    - SoftwarePackage
    - SoftwareRequirement
    - Provenance
    range: string
  modules:
    name: modules
    description: (Deprecated) Use environment.requirements list instead.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    domain_of:
    - SoftwareRequirement
    range: string
    multivalued: true
  version:
    name: version
    description: (Deprecated) Use version_spec.
    from_schema: https://w3id.org/tvbo/software
    domain_of:
    - ClinicalScale
    - SimulationTool
    - SoftwareRequirement
    - SoftwareEnvironment
    range: string

Induced

name: SoftwareRequirement
description: An individual software requirement binding a package to a version constraint
  and a role within an environment.
comments:
- Represents an individual requirement (package/module/library).
- Use 'version_spec' instead of 'version' for semantic clarity.
from_schema: https://w3id.org/tvbo/software
attributes:
  name:
    name: name
    from_schema: https://w3id.org/tvbo/software
    key: true
    alias: name
    owner: SoftwareRequirement
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Event
    - Tractogram
    - GraphGenerator
    - File
    - StateValue
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - Algorithm
    - Option
    - BranchSwitch
    - Continuation
    - Coupling
    range: string
    required: true
  description:
    name: description
    from_schema: https://w3id.org/tvbo/software
    alias: description
    owner: SoftwareRequirement
    domain_of:
    - Dataset
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Equation
    - Stimulus
    - Event
    - Tractogram
    - Matrix
    - Network
    - GraphGenerator
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - TuningObjective
    - Algorithm
    - BranchSwitch
    - Continuation
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  dataLocation:
    name: dataLocation
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    alias: dataLocation
    owner: SoftwareRequirement
    domain_of:
    - ParcellationTerminology
    - SoftwareRequirement
    - SoftwareEnvironment
    - Stimulus
    - Matrix
    - RandomStream
    - RegionMapping
    - TimeSeries
    - NDArray
    - Mesh
    range: string
  package:
    name: package
    description: Reference to the software package identity.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    alias: package
    owner: SoftwareRequirement
    domain_of:
    - SoftwareRequirement
    range: SoftwarePackage
  version_spec:
    name: version_spec
    description: Version or constraint specifier (e.g., '==2.7.3', '>=1.2,<2').
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    alias: version_spec
    owner: SoftwareRequirement
    domain_of:
    - SoftwareRequirement
    range: string
  role:
    name: role
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    ifabsent: runtime
    alias: role
    owner: SoftwareRequirement
    domain_of:
    - SoftwareRequirement
    range: RequirementRole
  optional:
    name: optional
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    ifabsent: 'False'
    alias: optional
    owner: SoftwareRequirement
    domain_of:
    - SoftwareRequirement
    range: boolean
  hash:
    name: hash
    description: Build or artifact hash for exact reproducibility.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    alias: hash
    owner: SoftwareRequirement
    domain_of:
    - SoftwareRequirement
    range: string
  source_url:
    name: source_url
    description: Canonical source or repository URL.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    alias: source_url
    owner: SoftwareRequirement
    domain_of:
    - SoftwareRequirement
    range: string
  url:
    name: url
    description: (Deprecated) Use source_url.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    alias: url
    owner: SoftwareRequirement
    domain_of:
    - SoftwareRequirement
    range: string
  license:
    name: license
    from_schema: https://w3id.org/tvbo/software
    alias: license
    owner: SoftwareRequirement
    domain_of:
    - CommonCoordinateSpace
    - SoftwarePackage
    - SoftwareRequirement
    - Provenance
    range: string
  modules:
    name: modules
    description: (Deprecated) Use environment.requirements list instead.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    alias: modules
    owner: SoftwareRequirement
    domain_of:
    - SoftwareRequirement
    range: string
    multivalued: true
  version:
    name: version
    description: (Deprecated) Use version_spec.
    from_schema: https://w3id.org/tvbo/software
    alias: version
    owner: SoftwareRequirement
    domain_of:
    - ClinicalScale
    - SimulationTool
    - SoftwareRequirement
    - SoftwareEnvironment
    range: string