Skip to content

Commit

Permalink
Deploying to gh-pages from @ 97326bc 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@PeterC-DLS
PeterC-DLS committed Feb 9, 2024
1 parent 1a1c809 commit 2096f98
Show file tree
Hide file tree
Showing 609 changed files with 223,751 additions and 32,426 deletions.
26,858 changes: 24,970 additions & 1,888 deletions _downloads/0d9b3db52a075e9d9b6a1a0457a842ba/nxdl_vocabulary.json
View file

Large diffs are not rendered by default.

21,190 changes: 19,607 additions & 1,583 deletions _downloads/593c638271dc6661be8a6d311d952a7f/nxdl_vocabulary.yml
View file

Large diffs are not rendered by default.

5,090 changes: 4,706 additions & 384 deletions _downloads/7edbd716ffba250f35d935c5b8c551e6/nxdl_vocabulary.txt
View file

Large diffs are not rendered by default.

1,430 changes: 1,083 additions & 347 deletions _downloads/dbcc5b21803e28207dd72ecba8d34e8a/nxdl_vocabulary.html
View file

Large diffs are not rendered by default.

110 changes: 58 additions & 52 deletions _sources/classes/applications/NXarchive.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,16 @@ NXarchive

**Description**:

This is a definition for data to be archived by ICAT (http://www.icatproject.org/).
.. collapse:: This is a definition for data to be archived by ICAT (http://www.icatproject.org ...

.. text from the icatproject.org site
This is a definition for data to be archived by ICAT (http://www.icatproject.org/).

the database (with supporting software) that provides an
interface to all ISIS experimental data and will provide
a mechanism to link all aspects of ISIS research from
proposal through to publication.
.. text from the icatproject.org site
the database (with supporting software) that provides an
interface to all ISIS experimental data and will provide
a mechanism to link all aspects of ISIS research from
proposal through to publication.
**Symbols**:

Expand All @@ -48,200 +50,202 @@ NXarchive

.. _/NXarchive/entry-group:

**entry**: (required) :ref:`NXentry`
**entry**: (required) :ref:`NXentry`


.. _/NXarchive/entry@index-attribute:

.. index:: index (group attribute)

**@index**: (required) :ref:`NX_CHAR <NX_CHAR>`
**@index**: (required) :ref:`NX_CHAR <NX_CHAR>`


.. _/NXarchive/entry/title-field:

.. index:: title (field)

**title**: (required) :ref:`NX_CHAR <NX_CHAR>`
**title**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/title-field>`


.. _/NXarchive/entry/experiment_identifier-field:

.. index:: experiment_identifier (field)

**experiment_identifier**: (required) :ref:`NX_CHAR <NX_CHAR>`
**experiment_identifier**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/experiment_identifier-field>`

unique identifier for the experiment

.. _/NXarchive/entry/experiment_description-field:

.. index:: experiment_description (field)

**experiment_description**: (required) :ref:`NX_CHAR <NX_CHAR>`
**experiment_description**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/experiment_description-field>`

Brief description of the experiment and its objectives

.. _/NXarchive/entry/collection_identifier-field:

.. index:: collection_identifier (field)

**collection_identifier**: (required) :ref:`NX_CHAR <NX_CHAR>`
**collection_identifier**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/collection_identifier-field>`

ID of user or DAQ define group of data files

.. _/NXarchive/entry/collection_description-field:

.. index:: collection_description (field)

**collection_description**: (required) :ref:`NX_CHAR <NX_CHAR>`
**collection_description**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/collection_description-field>`

Brief summary of the collection, including grouping criteria

.. _/NXarchive/entry/entry_identifier-field:

.. index:: entry_identifier (field)

**entry_identifier**: (required) :ref:`NX_CHAR <NX_CHAR>`
**entry_identifier**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/entry_identifier-field>`

unique identifier for this measurement as provided by the facility

.. _/NXarchive/entry/start_time-field:

.. index:: start_time (field)

**start_time**: (required) :ref:`NX_DATE_TIME <NX_DATE_TIME>`
**start_time**: (required) :ref:`NX_DATE_TIME <NX_DATE_TIME>` :ref:`⤆ </NXentry/start_time-field>`


.. _/NXarchive/entry/end_time-field:

.. index:: end_time (field)

**end_time**: (required) :ref:`NX_DATE_TIME <NX_DATE_TIME>`
**end_time**: (required) :ref:`NX_DATE_TIME <NX_DATE_TIME>` :ref:`⤆ </NXentry/end_time-field>`


.. _/NXarchive/entry/duration-field:

.. index:: duration (field)

**duration**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME <NX_TIME>`}
**duration**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME <NX_TIME>`}

TODO: needs documentation

.. _/NXarchive/entry/collection_time-field:

.. index:: collection_time (field)

**collection_time**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME <NX_TIME>`}
**collection_time**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME <NX_TIME>`} :ref:`⤆ </NXentry/collection_time-field>`

TODO: needs documentation

.. _/NXarchive/entry/run_cycle-field:

.. index:: run_cycle (field)

**run_cycle**: (required) :ref:`NX_CHAR <NX_CHAR>`
**run_cycle**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/run_cycle-field>`

TODO: needs documentation

.. _/NXarchive/entry/revision-field:

.. index:: revision (field)

**revision**: (required) :ref:`NX_CHAR <NX_CHAR>`
**revision**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/revision-field>`

revision ID of this file, may be after recalibration, reprocessing etc.

.. _/NXarchive/entry/definition-field:

.. index:: definition (field)

**definition**: (required) :ref:`NX_CHAR <NX_CHAR>`
**definition**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/definition-field>`

.. collapse:: Official NeXus NXDL schema to which this file conforms ...

Official NeXus NXDL schema to which this file conforms
Official NeXus NXDL schema to which this file conforms

Obligatory value: ``NXarchive``
Obligatory value: ``NXarchive``

.. _/NXarchive/entry/program-field:

.. index:: program (field)

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

The program and version used for generating this file

.. _/NXarchive/entry/program@version-attribute:

.. index:: version (field attribute)

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


.. _/NXarchive/entry/release_date-field:

.. index:: release_date (field)

**release_date**: (required) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_TIME <NX_TIME>`}
**release_date**: (required) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_TIME <NX_TIME>`}

when this file is to be released into PD

.. _/NXarchive/entry/user-group:

**user**: (required) :ref:`NXuser`
**user**: (required) :ref:`NXuser` :ref:`⤆ </NXentry/USER-group>`


.. _/NXarchive/entry/user/name-field:

.. index:: name (field)

**name**: (required) :ref:`NX_CHAR <NX_CHAR>`
**name**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXuser/name-field>`


.. _/NXarchive/entry/user/role-field:

.. index:: role (field)

**role**: (required) :ref:`NX_CHAR <NX_CHAR>`
**role**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXuser/role-field>`

role of the user

.. _/NXarchive/entry/user/facility_user_id-field:

.. index:: facility_user_id (field)

**facility_user_id**: (required) :ref:`NX_CHAR <NX_CHAR>`
**facility_user_id**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXuser/facility_user_id-field>`

ID of the user in the facility burocracy database

.. _/NXarchive/entry/instrument-group:

**instrument**: (required) :ref:`NXinstrument`
**instrument**: (required) :ref:`NXinstrument` :ref:`⤆ </NXentry/INSTRUMENT-group>`


.. _/NXarchive/entry/instrument/name-field:

.. index:: name (field)

**name**: (required) :ref:`NX_CHAR <NX_CHAR>`
**name**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXinstrument/name-field>`


.. _/NXarchive/entry/instrument/description-field:

.. index:: description (field)

**description**: (required) :ref:`NX_CHAR <NX_CHAR>`
**description**: (required) :ref:`NX_CHAR <NX_CHAR>`

Brief description of the instrument

.. _/NXarchive/entry/instrument/SOURCE-group:

**SOURCE**: (required) :ref:`NXsource`
**SOURCE**: (required) :ref:`NXsource` :ref:`⤆ </NXinstrument/SOURCE-group>`


.. _/NXarchive/entry/instrument/SOURCE/type-field:

.. index:: type (field)

**type**: (required) :ref:`NX_CHAR <NX_CHAR>`
**type**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsource/type-field>`


Any of these values:
Expand All @@ -265,51 +269,51 @@ NXarchive

.. index:: name (field)

**name**: (required) :ref:`NX_CHAR <NX_CHAR>`
**name**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsource/name-field>`


.. _/NXarchive/entry/instrument/SOURCE/probe-field:

.. index:: probe (field)

**probe**: (required) :ref:`NX_CHAR <NX_CHAR>`
**probe**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsource/probe-field>`


Any of these values: ``neutron`` | ``x-ray`` | ``electron``

.. _/NXarchive/entry/sample-group:

**sample**: (required) :ref:`NXsample`
**sample**: (required) :ref:`NXsample` :ref:`⤆ </NXentry/SAMPLE-group>`


.. _/NXarchive/entry/sample/name-field:

.. index:: name (field)

**name**: (required) :ref:`NX_CHAR <NX_CHAR>`
**name**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsample/name-field>`

Descriptive name of sample

.. _/NXarchive/entry/sample/sample_id-field:

.. index:: sample_id (field)

**sample_id**: (required) :ref:`NX_CHAR <NX_CHAR>`
**sample_id**: (required) :ref:`NX_CHAR <NX_CHAR>`

Unique database id of the sample

.. _/NXarchive/entry/sample/description-field:

.. index:: description (field)

**description**: (required) :ref:`NX_CHAR <NX_CHAR>`
**description**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsample/description-field>`


.. _/NXarchive/entry/sample/type-field:

.. index:: type (field)

**type**: (required) :ref:`NX_CHAR <NX_CHAR>`
**type**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsample/type-field>`


Any of these values:
Expand All @@ -333,59 +337,61 @@ NXarchive

.. index:: chemical_formula (field)

**chemical_formula**: (required) :ref:`NX_CHAR <NX_CHAR>`
**chemical_formula**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsample/chemical_formula-field>`

Chemical formula formatted according to CIF conventions

.. _/NXarchive/entry/sample/preparation_date-field:

.. index:: preparation_date (field)

**preparation_date**: (required) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_TIME <NX_TIME>`}
**preparation_date**: (required) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_TIME <NX_TIME>`}


.. _/NXarchive/entry/sample/situation-field:

.. index:: situation (field)

**situation**: (required) :ref:`NX_CHAR <NX_CHAR>`
**situation**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsample/situation-field>`

.. collapse:: Description of the environment the sample is in: ...

Description of the environment the sample is in:
air, vacuum, oxidizing atmosphere, dehydrated, etc.
Description of the environment the sample is in:
air, vacuum, oxidizing atmosphere, dehydrated, etc.

.. _/NXarchive/entry/sample/temperature-field:

.. index:: temperature (field)

**temperature**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`}
**temperature**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`} :ref:`⤆ </NXsample/temperature-field>`


.. _/NXarchive/entry/sample/magnetic_field-field:

.. index:: magnetic_field (field)

**magnetic_field**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}
**magnetic_field**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`} :ref:`⤆ </NXsample/magnetic_field-field>`


.. _/NXarchive/entry/sample/electric_field-field:

.. index:: electric_field (field)

**electric_field**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`}
**electric_field**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`} :ref:`⤆ </NXsample/electric_field-field>`


.. _/NXarchive/entry/sample/stress_field-field:

.. index:: stress_field (field)

**stress_field**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}
**stress_field**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} :ref:`⤆ </NXsample/stress_field-field>`


.. _/NXarchive/entry/sample/pressure-field:

.. index:: pressure (field)

**pressure**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PRESSURE <NX_PRESSURE>`}
**pressure**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PRESSURE <NX_PRESSURE>`} :ref:`⤆ </NXsample/pressure-field>`



Expand Down
Loading

0 comments on commit 2096f98

Please sign in to comment.