Class: SoftwareEnvironment

URI: tvbo:class/SoftwareEnvironment

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

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

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

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

        
      SoftwareEnvironment : environment_type
        
          
    
        
        
        SoftwareEnvironment --> "0..1" EnvironmentType : environment_type
        click EnvironmentType href "../../enums/EnvironmentType.html"
    

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

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

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

        
      SoftwareEnvironment : requirements
        
          
    
        
        
        SoftwareEnvironment --> "*" SoftwareRequirement : requirements
        click SoftwareRequirement href "./SoftwareRequirement.html"
    

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

        
      

Slots

Name Cardinality and Range Description Inheritance
label 0..1
xsd:string
direct
description 0..1
xsd:string
direct
dataLocation 0..1
xsd:string
Add the location of the data file containing the parcellation terminology direct
name 0..1
xsd:string
Human-readable environment label/name (deprecated alias was ‘software’) direct
version 0..1
xsd:string
Optional version tag for the environment definition (not a package version) direct
platform 0..1
xsd:string
OS / architecture description (e direct
environment_type 0..1
EnvironmentType
Category: conda, venv, docker, etc direct
container_image 0..1
xsd:string
Container image reference (e direct
build_hash 0..1
xsd:string
Deterministic hash/fingerprint of the resolved dependency set direct
requirements *
SoftwareRequirement
Constituent software/module requirements that define this environment direct

Usages

used by used in type used
Observation environment range SoftwareEnvironment
DerivedObservation environment range SoftwareEnvironment
SimulationExperiment environment range SoftwareEnvironment
TimeSeries software_environment range SoftwareEnvironment
PDESolver environment range SoftwareEnvironment

Comments

  • An environment now aggregates one or more SoftwareRequirement entries.
  • Use SimulationExperiment.environment to reference a reusable environment.
  • Field ‘name’ supersedes previous ‘software’ attribute for clarity.
  • ‘version’ here is an environment spec version, not a package version.

Identifier and Mapping Information

Schema Source

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

Mappings

Mapping Type Mapped Value
self tvbo:SoftwareEnvironment
native tvbo:SoftwareEnvironment

LinkML Source

Direct

name: SoftwareEnvironment
comments:
- An environment now aggregates one or more SoftwareRequirement entries.
- Use SimulationExperiment.environment to reference a reusable environment.
- Field 'name' supersedes previous 'software' attribute for clarity.
- '''version'' here is an environment spec version, not a package version.'
from_schema: https://w3id.org/tvbo
slots:
- label
- description
- dataLocation
attributes:
  name:
    name: name
    description: Human-readable environment label/name (deprecated alias was 'software').
    from_schema: https://w3id.org/tvbo
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - Tractogram
    - File
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - Algorithm
    - Coupling
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    range: string
  version:
    name: version
    description: Optional version tag for the environment definition (not a package
      version).
    from_schema: https://w3id.org/tvbo
    domain_of:
    - ClinicalScale
    - SoftwareEnvironment
    - SoftwareRequirement
    range: string
  platform:
    name: platform
    description: OS / architecture description (e.g., linux-64).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - SoftwareEnvironment
    range: string
  environment_type:
    name: environment_type
    description: 'Category: conda, venv, docker, etc.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - SoftwareEnvironment
    range: EnvironmentType
  container_image:
    name: container_image
    description: Container image reference (e.g., ghcr.io/org/img:tag@sha256:...).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - SoftwareEnvironment
    range: string
  build_hash:
    name: build_hash
    description: Deterministic hash/fingerprint of the resolved dependency set.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - SoftwareEnvironment
    range: string
  requirements:
    name: requirements
    description: Constituent software/module requirements that define this environment.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Function
    - SoftwareEnvironment
    - PDESolver
    range: SoftwareRequirement
    multivalued: true
    inlined: true

Induced

name: SoftwareEnvironment
comments:
- An environment now aggregates one or more SoftwareRequirement entries.
- Use SimulationExperiment.environment to reference a reusable environment.
- Field 'name' supersedes previous 'software' attribute for clarity.
- '''version'' here is an environment spec version, not a package version.'
from_schema: https://w3id.org/tvbo
attributes:
  name:
    name: name
    description: Human-readable environment label/name (deprecated alias was 'software').
    from_schema: https://w3id.org/tvbo
    alias: name
    owner: SoftwareEnvironment
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - Tractogram
    - File
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - Algorithm
    - Coupling
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    range: string
  version:
    name: version
    description: Optional version tag for the environment definition (not a package
      version).
    from_schema: https://w3id.org/tvbo
    alias: version
    owner: SoftwareEnvironment
    domain_of:
    - ClinicalScale
    - SoftwareEnvironment
    - SoftwareRequirement
    range: string
  platform:
    name: platform
    description: OS / architecture description (e.g., linux-64).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: platform
    owner: SoftwareEnvironment
    domain_of:
    - SoftwareEnvironment
    range: string
  environment_type:
    name: environment_type
    description: 'Category: conda, venv, docker, etc.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: environment_type
    owner: SoftwareEnvironment
    domain_of:
    - SoftwareEnvironment
    range: EnvironmentType
  container_image:
    name: container_image
    description: Container image reference (e.g., ghcr.io/org/img:tag@sha256:...).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: container_image
    owner: SoftwareEnvironment
    domain_of:
    - SoftwareEnvironment
    range: string
  build_hash:
    name: build_hash
    description: Deterministic hash/fingerprint of the resolved dependency set.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: build_hash
    owner: SoftwareEnvironment
    domain_of:
    - SoftwareEnvironment
    range: string
  requirements:
    name: requirements
    description: Constituent software/module requirements that define this environment.
    from_schema: https://w3id.org/tvbo
    alias: requirements
    owner: SoftwareEnvironment
    domain_of:
    - Function
    - SoftwareEnvironment
    - PDESolver
    range: SoftwareRequirement
    multivalued: true
    inlined: true
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: label
    owner: SoftwareEnvironment
    domain_of:
    - ParcellationTerminology
    - Dataset
    - Contact
    - Equation
    - Stimulus
    - Parcellation
    - Tractogram
    - Matrix
    - Network
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - Function
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - TuningObjective
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - DifferentialOperator
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: SoftwareEnvironment
    domain_of:
    - ClinicalScore
    - Equation
    - Stimulus
    - Tractogram
    - Matrix
    - Network
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - TuningObjective
    - Algorithm
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  dataLocation:
    name: dataLocation
    description: Add the location of the data file containing the parcellation terminology.
    from_schema: https://openminds.ebrains.eu/sands/BrainAtlas
    alias: dataLocation
    owner: SoftwareEnvironment
    domain_of:
    - ParcellationTerminology
    - Stimulus
    - Matrix
    - RandomStream
    - RegionMapping
    - TimeSeries
    - SoftwareEnvironment
    - SoftwareRequirement
    - NDArray
    - Mesh
    range: string