>From 3fcd9b9ebf78432b895b7b846e0e973f7b97ae1e Mon Sep 17 00:00:00 2001 From: Peter Colberg Date: Tue, 30 Jul 2013 23:16:55 -0400 Subject: [PATCH] Organize meta-data of author and creator into subgroups. http://thread.gmane.org/gmane.science.simulation.h5md.user/206/focus=209 --- draft.rst | 47 +++++++++++++++++++++++++++-------------------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/draft.rst b/draft.rst index a6e7bf2..608d0f9 100644 --- a/draft.rst +++ b/draft.rst @@ -199,34 +199,41 @@ A set of global metadata describing the file is stored in the ``h5md`` group as attributes. The contents of the group is:: h5md - +-- author - +-- (author_email) - +-- creator - +-- creator_version +-- version + \-- author + | +-- name + | +-- (email) + \-- creator + +-- name + +-- version + +``version`` + An attribute that states the version of the H5MD specification that + the file conforms to. It is an integer dataset of dimension \[2\], with the + first element as the major version number ``1`` and the second element as the + minor version number ``0``. ``author`` - An attribute that identifies the real name of the person responsible - for the simulation (or the experiment) as a string. + A group that contains meta-data on the person responsible for the simulation + (or the experiment) as follows: -``author_email`` - An optional attribute that holds the author's email address as a string of - the form address@hidden + ``name`` + An attribute that holds the author's real name as a string. + + ``email`` + An optional attribute that holds the author's email address as a string of + the form address@hidden ``creator`` - An attribute that stores the name of the program that created the - file as a string. + A group that contains meta-data on the program that created the file + as follows: -``creator_version`` - An attribute that yields the version of the program that - created the file, as a string containing a proper identification for the - given program. + ``name`` + An attribute that stores the name of the program as a string. -``version`` - An attribute that states the version of the H5MD specification that - the file conforms to. It is an integer dataset of dimension \[2\], with the - first element as the major version number ``1`` and the second element as the - minor version number ``0``. + ``version`` + An attribute that yields the version of the program, as a string + containing a proper identification for the given program. Particles group -- 1.8.3.2