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

.. index::
    ! NXprogram (base class)
    ! program (base class)
    see: program (base class); NXprogram

.. _NXprogram:

=========
NXprogram
=========

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Base class to describe a software tool or library.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXprogram/program-field:

  .. index:: program (field)

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

    .. collapse:: Given name of the program. Program can be a commercial one a script, ...

        Given name of the program. Program can be a commercial one a script,
        or a library or a library component.

    .. _/NXprogram/program@version-attribute:

    .. index:: version (field attribute)

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

      Program version plus build number, or commit hash.

    .. _/NXprogram/program@url-attribute:

    .. index:: url (field attribute)

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

      .. collapse:: Description of an ideally ever persistent resource where the source code ...

          Description of an ideally ever persistent resource where the source code
          of the program or this specific compiled version of the program can be
          found so that the program yields repeatably exactly the same numerical
          and categorical results.


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

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


* :ref:`/NXprogram/program-field </NXprogram/program-field>`
* :ref:`/NXprogram/program@url-attribute </NXprogram/program@url-attribute>`
* :ref:`/NXprogram/program@version-attribute </NXprogram/program@version-attribute>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXprogram.nxdl.xml