Documentation for Developers

Each FACETS run should put out sufficient metadata so as to be able to duplicate that run precisely. This metadata comprises the provenance or how the data originated. It may be impossible to record every aspect of a simulation, but the categories below provide a start.

Run metadata

  • Input files. If stored in a repository, the repository and file version.
  • Machine on which simulation run
  • Run scripts, which contain information such as number of processors used.
  • Date and time of simulation run
  • User name or account of who generated run

Executable metadata

  • Repository version of framework including externals and whether any files have changed since software checkout.
  • Repository version and modification status of all components.
  • Compiler flags for framework and components.
  • Machine on which framework and components were built.
  • Versions of any linked libraries.

Visualization metadata

Visualization metadata is described at  VizSchema site

Example of HDF5 output collecting run and viz data

HDF5 "anisodiffusions_1.h5" {
GROUP "/runInfo" {
   ATTRIBUTE "HAVE_BABEL_SHARED" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "HAVE_BABEL_STATIC" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "HAVE_BHSSOLVER" {
      DATATYPE  H5T_STRING {
            STRSIZE 2;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "NO"
      }
   }
   ATTRIBUTE "HAVE_FMCFM" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "HAVE_FMCFM_0_9" {
      DATATYPE  H5T_STRING {
            STRSIZE 2;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "NO"
      }
   }
   ATTRIBUTE "HAVE_NUBEAM" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "HAVE_PLASMASTATE" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "HAVE_PSPLINE" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "HAVE_TGLF" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "HAVE_TRANSPBASE" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "HAVE_TRANSPGRAPHICS" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "HAVE_WALLPSI" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "YES"
      }
   }
   ATTRIBUTE "UEDGE_SHARED" {
      DATATYPE  H5T_STRING {
            STRSIZE 2;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "NO"
      }
   }
   ATTRIBUTE "UEDGE_STATIC" {
      DATATYPE  H5T_STRING {
            STRSIZE 2;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "NO"
      }
   }
   ATTRIBUTE "vsBuildHost" {
      DATATYPE  H5T_STRING {
            STRSIZE 26;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "ammars-computer-3006.local"
      }
   }
   ATTRIBUTE "vsBuildHostType" {
      DATATYPE  H5T_STRING {
            STRSIZE 22;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "i386-apple-darwin9.8.0"
      }
   }
   ATTRIBUTE "vsCommandLine" {
      DATATYPE  H5T_STRING {
            STRSIZE 87;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "/Users/ammar/software/facets-r3207/bin/facetser -i
anisodiffusion.in -o anisodiffusions"
      }
   }
   ATTRIBUTE "vsConfigDate" {
      DATATYPE  H5T_STRING {
            STRSIZE 28;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "Thu Aug 19 13:53:29 MDT 2010"
      }
   }
   ATTRIBUTE "vsConfigLine" {
      DATATYPE  H5T_STRING {
            STRSIZE 412;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "/Users/ammar/research/txcorp/facetsall/facets/configure
'--prefix=/Users/ammar/software/facets-r3207' '--disable-parallel'
'CC=gcc' 'CXX=g++' 'FC=gfortran' 'F77=gfortran' 'CFLAGS=-fPIC'
'CXXFLAGS=-fPIC' 'FFLAGS=-fPIC' 'FCFLAGS=-fPIC'
'--with-lapack=-framework Accelerate' '--with-blas=-framework
Accelerate' '--with-hdf5-dir=/Users/ammar/software/hdf5-1.8.4-ser'
'--with-supra-search-path=/Users/ammar/software'"
      }
   }
   ATTRIBUTE "vsConfigRevision" {
      DATATYPE  H5T_STRING {
            STRSIZE 4;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "3620"
      }
   }
   ATTRIBUTE "vsCxxCompiler" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "g++"
      }
   }
   ATTRIBUTE "vsCxxCompilerFlags" {
      DATATYPE  H5T_STRING {
            STRSIZE 43;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): " -g -O2 -pipe -ansi -Wall -Wno-unused -fPIC"
      }
   }
   ATTRIBUTE "vsCxxCompilerOptiFlags" {
      DATATYPE  H5T_STRING {
            STRSIZE 12;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "-g -O2 -pipe"
      }
   }
   ATTRIBUTE "vsCxxCompilerVersion" {
      DATATYPE  H5T_STRING {
            STRSIZE 5;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "4.0.1"
      }
   }
   ATTRIBUTE "vsFcVersion" {
      DATATYPE  H5T_STRING {
            STRSIZE 5;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "4.4.1"
      }
   }
   ATTRIBUTE "vsSoftware" {
      DATATYPE  H5T_STRING {
            STRSIZE 6;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "FACETS"
      }
   }
   ATTRIBUTE "vsSwRevision" {
      DATATYPE  H5T_STRING {
            STRSIZE 4;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "3207"
      }
   }
   ATTRIBUTE "vsSwVersion" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "0.5"
      }
   }
   ATTRIBUTE "vsType" {
      DATATYPE  H5T_STRING {
            STRSIZE 7;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "runInfo"
      }
   }
   ATTRIBUTE "vsVsVersion" {
      DATATYPE  H5T_STRING {
            STRSIZE 3;
            STRPAD H5T_STR_NULLTERM;
            CSET H5T_CSET_ASCII;
            CTYPE H5T_C_S1;
         }
      DATASPACE  SCALAR
      DATA {
      (0): "2.1"
      }
   }
}
}

Metadata automatically collected by TAU

On Linux:

AttributeSample Value
Metric NameTime
Starting Timestamp1222790931031078
UTC Time2008-09-30T16:08:52Z
Local Time2008-09-30T09:08:52-07:00
Timestamp1222790932158892
Hostnamedemon.nic.uoregon.edu
OS NameLinux
OS Version#1 SMP Fri Nov 3 07:34:13 PST 2006
OS Release2.6.9-42.0.3.EL.perfctrsmp
OS Machinex86_64
Node Namedemon.nic.uoregon.edu
TAU Architecturex86_64
TAU Config -pdt=/home/amorris/pdtoolkit -mpiinc=/usr/local/packages/openmpi-1.2/intel-9.1/include -mpilib=/usr/local/packages/openmpi-1.2/intel-9.1/lib -cc=icc -c++=icpc -fortran=intel
TAU Version2.17-cvs
pid31508
CPU VendorGenuineIntel
CPU TypeIntel(R) Xeon(R) CPU 5160 @ 3.00GHz
CPU MHz2992.509
Cache Size4096 KB
CPU Cores2
Memory Size8161240 kB
Executable/home/amorris/tau2/examples/pdt_mpi/c/ring
CWD/home/amorris/tau2/examples/pdt_mpi/c
usernameamorris
MPI Processor Namedemon.nic.uoregon.edu