#################
ProtocolExecution
#################

:Semantic name: https://openminds.ebrains.eu/core/ProtocolExecution

:Display as: Protocol execution

Structured information on a protocol execution.


------------

------------

Properties
##########

:Required: `input <input_heading_>`_, `output <output_heading_>`_, `protocol <protocol_heading_>`_
:Optional: `description <description_heading_>`_, `lookupLabel <lookupLabel_heading_>`_, `parameterSet <parameterSet_heading_>`_, `preparationType <preparationType_heading_>`_, `semanticallyAnchoredTo <semanticallyAnchoredTo_heading_>`_, `studyTarget <studyTarget_heading_>`_

------------

.. _description_heading:

***********
description
***********

Longer statement or account giving the characteristics of someone or something.

.. admonition:: schema_specifications

   :semantic name: https://openminds.ebrains.eu/vocab/description
   :value type: | string
                | formatting: text/markdown; multiline
   :instructions: Enter a description of this protocol execution.

`BACK TO TOP <ProtocolExecution_>`_

------------

.. _input_heading:

*****
input
*****

Something or someone that is put into or participates in a process or machine.

.. admonition:: schema_specifications

   :semantic name: https://openminds.ebrains.eu/vocab/input
   :value type: | linked object array \(1-N\) of type
                | `FileBundle <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/data/fileBundle.html>`_, `File <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/data/file.html>`_, `SubjectGroupState <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/subjectGroupState.html>`_, `SubjectState <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/subjectState.html>`_, `TissueSampleCollectionState <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/tissueSampleCollectionState.html>`_ or `TissueSampleState <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/tissueSampleState.html>`_
   :instructions: Add all inputs (subject state, tissue sample state, file instance or file bundle) used by this protocol execution.

`BACK TO TOP <ProtocolExecution_>`_

------------

.. _lookupLabel_heading:

***********
lookupLabel
***********

.. admonition:: schema_specifications

   :semantic name: https://openminds.ebrains.eu/vocab/lookupLabel
   :value type: | string
                | formatting: text/plain; singleline
   :instructions: Enter a lookup label for this protocol execution that may help you to more easily find it again.

`BACK TO TOP <ProtocolExecution_>`_

------------

.. _output_heading:

******
output
******

Something or someone that comes out of, is delivered or produced by a process or machine.

.. admonition:: schema_specifications

   :semantic name: https://openminds.ebrains.eu/vocab/output
   :value type: | linked object array \(1-N\) of type
                | `FileBundle <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/data/fileBundle.html>`_, `File <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/data/file.html>`_, `SubjectGroupState <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/subjectGroupState.html>`_, `SubjectState <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/subjectState.html>`_, `TissueSampleCollectionState <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/tissueSampleCollectionState.html>`_ or `TissueSampleState <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/tissueSampleState.html>`_
   :instructions: Add all outputs (subject state, tissue sample state, file instance or file bundle) generated by this protocol execution.

`BACK TO TOP <ProtocolExecution_>`_

------------

.. _parameterSet_heading:

************
parameterSet
************

Manner, position, or direction in which digital or physical properties are set to determine a particular function, characteristics or behavior of something.

.. admonition:: schema_specifications

   :semantic name: https://openminds.ebrains.eu/vocab/parameterSet
   :value type: | embedded object array \(1-N\) of type
                | `ParameterSet <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/parameterSet.html>`_
   :instructions: Add all important parameters grouped in context-specific sets that were used in this protocol execution.

`BACK TO TOP <ProtocolExecution_>`_

------------

.. _preparationType_heading:

***************
preparationType
***************

Distinct class of actions or processes that make something ready for use or service.

.. admonition:: schema_specifications

   :semantic name: https://openminds.ebrains.eu/vocab/preparationType
   :value type: | linked object of type
                | `PreparationType <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/preparationType.html>`_
   :instructions: Add the initial preparation type for this protocol execution.

`BACK TO TOP <ProtocolExecution_>`_

------------

.. _protocol_heading:

********
protocol
********

Plan that describes the process of a scientific or medical experiment, treatment, or procedure.

.. admonition:: schema_specifications

   :semantic name: https://openminds.ebrains.eu/vocab/protocol
   :value type: | linked object of type
                | `Protocol <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/core/research/protocol.html>`_
   :instructions: Add the protocol of this protocol execution.

`BACK TO TOP <ProtocolExecution_>`_

------------

.. _semanticallyAnchoredTo_heading:

**********************
semanticallyAnchoredTo
**********************

Reference to a related anatomical structure without providing a quantitative proof of the claimed relation.

.. admonition:: schema_specifications

   :semantic name: https://openminds.ebrains.eu/vocab/semanticallyAnchoredTo
   :value type: | linked object array \(1-N\) of type
                | AnatomicalEntity \[TYPE_ERROR\]
   :instructions: Add all anatomical entities to which the outputs of this protocol execution can be semantically anchored to.

`BACK TO TOP <ProtocolExecution_>`_

------------

.. _studyTarget_heading:

***********
studyTarget
***********

Structure or function that was targeted within a study.

.. admonition:: schema_specifications

   :semantic name: https://openminds.ebrains.eu/vocab/studyTarget
   :value type: | linked object array \(1-N\) of type
                | `BiologicalSex <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/biologicalSex.html>`_, `CellType <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/cellType.html>`_, `Disease <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/disease.html>`_, `DiseaseModel <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/diseaseModel.html>`_, `Handedness <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/handedness.html>`_, `Organ <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/organ.html>`_, `Phenotype <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/phenotype.html>`_, `Species <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/species.html>`_, `Strain <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/strain.html>`_, `TermSuggestion <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/controlledTerms/termSuggestion.html>`_, `CustomAnatomicalEntity <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/SANDS/non-atlas/customAnatomicalEntity.html>`_ or `ParcellationEntity <https://openminds-documentation.readthedocs.io/en/v2.0/schema_specifications/SANDS/atlas/parcellationEntity.html>`_
   :instructions: Add all study targets of this model version.

`BACK TO TOP <ProtocolExecution_>`_

------------