.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXcs_computer.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXcs_computer (base class)
    ! cs_computer (base class)
    see: cs_computer (base class); NXcs_computer

.. _NXcs_computer:

=============
NXcs_computer
=============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Computer science description of a set of computing nodes.

**Symbols**:

  The symbols used in the schema to specify e.g. dimensions of arrays.

**Groups cited**:
  :ref:`NXcs_cpu`, :ref:`NXcs_gpu`, :ref:`NXcs_io_sys`, :ref:`NXcs_mm_sys`

.. index:: NXcs_cpu (base class); used in base class, NXcs_gpu (base class); used in base class, NXcs_mm_sys (base class); used in base class, NXcs_io_sys (base class); used in base class

**Structure**:

  .. _/NXcs_computer/name-field:

  .. index:: name (field)

  **name**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Given name/alias to the computing system, e.g. MyDesktop.

  .. _/NXcs_computer/operating_system-field:

  .. index:: operating_system (field)

  **operating_system**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Name of the operating system, e.g. Windows, Linux, Mac, Android.

    .. _/NXcs_computer/operating_system@version-attribute:

    .. index:: version (field attribute)

    **@version**: (optional) :ref:`NX_CHAR <NX_CHAR>`

      Version plus build number, commit hash, or description of an ever 
      persistent resource where the source code of the program and build
      instructions can be found so that the program can be configured in
      such a manner that the result file is ideally recreatable yielding
      the same results.

  .. _/NXcs_computer/uuid-field:

  .. index:: uuid (field)

  **uuid**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Ideally a (globally) unique persistent identifier of the computer, i.e.
    the Universally Unique Identifier (UUID) of the computing node.

  .. _/NXcs_computer/CS_CPU-group:

  **CS_CPU**: (optional) :ref:`NXcs_cpu`

    A list of physical processing units (can be multi-core chips).

  .. _/NXcs_computer/CS_GPU-group:

  **CS_GPU**: (optional) :ref:`NXcs_gpu`

    A list of physical coprocessor/graphic cards/accelerator units.

  .. _/NXcs_computer/CS_MM_SYS-group:

  **CS_MM_SYS**: (optional) :ref:`NXcs_mm_sys`

    Details about the memory sub-system.

  .. _/NXcs_computer/CS_IO_SYS-group:

  **CS_IO_SYS**: (optional) :ref:`NXcs_io_sys`

    Details about the I/O sub-system.


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXcs_computer/CS_CPU-group </NXcs_computer/CS_CPU-group>`
* :ref:`/NXcs_computer/CS_GPU-group </NXcs_computer/CS_GPU-group>`
* :ref:`/NXcs_computer/CS_IO_SYS-group </NXcs_computer/CS_IO_SYS-group>`
* :ref:`/NXcs_computer/CS_MM_SYS-group </NXcs_computer/CS_MM_SYS-group>`
* :ref:`/NXcs_computer/name-field </NXcs_computer/name-field>`
* :ref:`/NXcs_computer/operating_system-field </NXcs_computer/operating_system-field>`
* :ref:`/NXcs_computer/operating_system@version-attribute </NXcs_computer/operating_system@version-attribute>`
* :ref:`/NXcs_computer/uuid-field </NXcs_computer/uuid-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXcs_computer.nxdl.xml