Skip to content

save_dmp_hdf5.m

Basic Information

  SYNTAX:  save_dmp_hdf5(hdf5_struct, alt_name, append, verbose)

  PURPOSE:
    Save a structure of the type defined by dmphdf5_struct.m as an hdf5
    file of the format for the DIII-D DMP hdf5 format.


  INPUTS:
       hdf5_struct:    The struct containing publication informations
                       and figure data of the format defined in
                       dmphdf5_struct.

       alt_name:       By default, the hdf5 file is named following a
                       convention set by the DIII-D DMP. This allows a
                       user to use a different filename if they should
                       choose. The default which is used for DIII-D
                       DMP is:
                       DIII-D_[AuthorLastName]_[JournalName]_[PublicationYear]_Fig[figNumber].h5

       append:         [default = 0] Append new datasets and update
                       information in a pre-existing hdf5 file with
                       the same name. Default is 0, which will delete
                       the previouds version of the hdf5 file before
                       creating a new one.

       verbose:        [default = 1] Print all warnings in addition to
                       returning them.

  OUTPUTS:
       ier:            0 if no warnings after checking the structure
                       before saving, otherwise 1.

       warnings:       A cell array of strings of warnings on missing
                       fields or other problems with the structure.


  RESTRICTIONS:

  WRITTEN BY:  Jayson Barr ON 10/11/18

  MODIFICATION HISTORY:

Dependencies