Skip to content

dmphdf5_struct.m

Basic Information

  SYNTAX:  dmphdf5_struct(varargin)

  PURPOSE:
    Make a structure to hold data and plot information for exporting to
    the hdf5 format used for the DIII-D DMP. With no options the output
    structure has all of the required fields, but set to empty strings
    as an initialized template.

  INPUTS:
       varagin:    Pairs of strings defining fields to define in the
                   output structure in addition to the data
                   incorporated from the figures. For example, to add
                   info for the data provider these two added args
                   would work:
                        dmphdf5_struct('data_provider','John Doe')

  OUTPUTS:
       dmphdf5:    The output structure for exporting to the DIII-D
                   DMP hdf5 format. By default the fields are:
                       -author_last:  [string] The author's last name
                       -journal: [string] the journal published in
                       -publication_year:  [string] the year of
                                           publication as a string
                       -data_provider:     [string] the name of the person
                                           person that provided the
                                           data in this graph
                       -doc_number:    [string] the DIII-D doc number
                                       for this article or document -
                                       it is assigned by the DIII-D
                                       publications tracker.
                       -figure_number: [string] the figure number in
                                       the document.
                                       Ex: '1', '2b', '3abc'
                       -citation:  [string] a full citation for the
                                   publication that the figure appears
                                   in.
                       -DATA:      [struct] a structure in which the
                                   data from a figure is stored.
                                   Datasets from a figure are to be
                                   labeled DATA.dataset#, and should
                                   each have a corresponding
                                   DATA.dataheader# which has
                                   comma-separated header information
                                   defining each column of the data.


  RESTRICTIONS:

  WRITTEN BY:  Jayson Barr ON 10/11/18

  MODIFICATION HISTORY:

Dependencies