Changeset 442 for CMIP6dreqbuild/trunk/src

Timestamp:

24/10/15 23:05:00 (7 years ago)

Author:

mjuckes

Message:

Preparing to split documents as a separate package

Location:

CMIP6dreqbuild/trunk/src/framework

Files:

• Makefile (modified) (1 diff)
• dreqPy/__init__.py (modified) (1 diff)
• dreqPy/dreq.py (modified) (6 diffs)
• dreqPy/packageConfig.py (added)
• out/dreq2Defn.xml (modified) (20 diffs)
• ptxt.py (modified) (2 diffs)
• scanDreq.py (modified) (2 diffs)

CMIP6dreqbuild/trunk/src/framework/Makefile

@@ -62 +62 @@
         bash seddreq02.sh "\.\.\/out" "\.\.\/docs" dreqPy/__init__.py > /data/tmp/svn3/exarch/CMIP6dreq/trunk/dreqPy/__init__.py
         cp htmlTemplates.py dreqPy/scope.py dreqPy/example.py dreqPy/utilities.py /data/tmp/svn3/exarch/CMIP6dreq/trunk/dreqPy  
+        cp dreqPy/dreqCmdl.py  dreqPy/simpleCheck.py /data/tmp/svn3/exarch/CMIP6dreq/trunk/dreqPy
         cp vocabDemo.py /data/tmp/svn3/exarch/CMIP6dreq/trunk/dreqPy    
         cp out/annotated_20150731.xml /data/tmp/svn3/exarch/CMIP6dreq/trunk/docs/dreq.xml

CMIP6dreqbuild/trunk/src/framework/dreqPy/__init__.py

@@ -1 +1 @@
 
-import os
+from packageConfig import *
 
-HERE = os.path.dirname(os.path.abspath(__file__) )
-
-##DOC_DEFAULT_DIR
-DOC_DEFAULT_DIR = os.path.join(HERE, '../out')
-
-DOC_DIR = os.environ.get('DRQ_CONFIG_DIR', DOC_DEFAULT_DIR)
-
-__versionComment__ = "Support for command line interface added"
-__version__ = "01.beta.09"
-__title__ = "dreqPy"
-__description__ = "CMIP6 Data Request Python API"
-__uri__ = "http://proj.badc.rl.ac.uk/svn/exarch/CMIP6dreq/tags/{0}".format(__version__)
-__author__ = "Martin Juckes"
-__email__ = "martin.juckes@stfc.ac.uk"
-__license__ = "BSD"
-__copyright__ = "Copyright (c) 2015 Science & Technology Facilities Council (STFC)"

CMIP6dreqbuild/trunk/src/framework/dreqPy/dreq.py

@@ -58 +58 @@
            for a in self.__dict__.keys():
              if a[0] != '_' or full:
-               if self._a[a].rClass == 'internalLink' and self._base._indexInitialised:
+               if self._a[a].useClass == 'internalLink' and self._base._indexInitialised:
                  if self.__dict__[a] in self._base._inx.uid:
                    targ = self._base._inx.uid[ self.__dict__[a] ]
@@ -89 +89 @@
            for a in self.__dict__.keys():
              if a[0] != '_':
-               if self._a[a].rClass == 'internalLink' and self._base._indexInitialised:
+               if self._a[a].useClass == 'internalLink' and self._base._indexInitialised:
                  if self.__dict__[a] == '__unset__':
                    m = '<li>%s: %s [missing link]</li>' % ( a, self.__dict__[a] )
@@ -222 +222 @@
     self.vsamp = thisdoc
     self.nts = collections.namedtuple( 'sectdef', ['tag','label','title','id','itemLabelMode','level'] )
-    self.nti = collections.namedtuple( 'itemdef', ['tag','label','title','type','rClass','techNote'] )
+    self.nti = collections.namedtuple( 'itemdef', ['tag','label','title','type','useClass','techNote'] )
     self.ntt = collections.namedtuple( 'sectinit', ['header','attributes','defaults'] )
     self.nt__default = collections.namedtuple( 'deflt', ['defaults','glob'] )
@@ -325 +325 @@
 The instanstiated object contains a single data record. The "_h" attribute links to information about the record and the section it belongs to. 
 
-object._a: a python dictionary defining the attributes in each record. The keys in the dictionary correspond to the attribute names and the values are python "named tuples" (from the "collections" module). E.g. object._a['priority'].type contains the type of the 'priority' attribute. Type is expressed using XSD schema language, so "xs:integer" implies integer.  The "rClass" attribute carries information about usage. If object._a['xxx'].rClass = u'internalLink' then the record attribute provides a link to another element and object.xxx is the unique identifier of that element.
+object._a: a python dictionary defining the attributes in each record. The keys in the dictionary correspond to the attribute names and the values are python "named tuples" (from the "collections" module). E.g. object._a['priority'].type contains the type of the 'priority' attribute. Type is expressed using XSD schema language, so "xs:integer" implies integer.  The "useClass" attribute carries information about usage. If object._a['xxx'].useClass = u'internalLink' then the record attribute provides a link to another element and object.xxx is the unique identifier of that element.
 
 object._h: a python named tuple describing the section. E.g. object._h.title is the section title (E.g. "CMOR Variables")
@@ -361 +361 @@
       defs = {'type':"xs:string"}
       ll = []
-      for k in ['label','title','type','class','techNote']:
+      for k in ['label','title','type','useClass','techNote']:
         if i.hasAttribute( k ):
           ll.append( i.getAttribute( k ) )
@@ -408 +408 @@
     ##
       for ka in dreq[k].attDefn.keys():
-        if dreq[k].attDefn[ka].rClass == 'internalLink':
+        if dreq[k].attDefn[ka].useClass == 'internalLink':
            irefdict[k].append( ka )
 

CMIP6dreqbuild/trunk/src/framework/out/dreq2Defn.xml

@@ -7 +7 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="sn" title="CF Standard Name" class="externalTextRef"/>
+  <rowAttribute label="sn" title="CF Standard Name" useClass="internalLink"/>
   <rowAttribute label="units" title="Units"/>
   <rowAttribute label="description"/>
   <rowAttribute label="title" title="Long name"/>
-  <rowAttribute label="procnote" title="Processing notes" class="list"/>
-  <rowAttribute label="procComment" title="Processing comments" class="freeText"/>
-  <rowAttribute label="prov" title="Provenance" class="freeText"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
+  <rowAttribute label="procnote" title="Processing notes" useClass="list"/>
+  <rowAttribute label="procComment" title="Processing comments" useClass="freeText"/>
+  <rowAttribute label="prov" title="Provenance" useClass="freeText"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
 </table>
 <table label="CMORvar" uid="SECTION:CMORvar" title="CMOR Variable" id="cmip.drv.002" itemLabelMode="def" level="1" maxOccurs="1" labUnique="No">
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
+  <rowAttribute label="uid" useClass="recordId"/>
   <rowAttribute label="title" title="Long name"/>
-  <rowAttribute label="stid" title="Link to a record specifying the structure of the variable (dimensions and associated variable attributes)." class="internalLink" techNote="structure"/>
-  <rowAttribute label="vid" title="Identifier for MIP Variable" class="internalLink" techNote="var"/>
+  <rowAttribute label="stid" title="Link to a record specifying the structure of the variable (dimensions and associated variable attributes)." useClass="internalLink" techNote="structure"/>
+  <rowAttribute label="vid" title="Identifier for MIP Variable" useClass="internalLink" techNote="var"/>
   <rowAttribute label="valid_min" title="Minimum expected value for this variable."/>
   <rowAttribute label="valid_max" title="Maximum expected value for this variable."/>
@@ -30 +30 @@
   <rowAttribute label="deflate_level" title="Deflate Level: NetCDF compression parameter"/>
   <rowAttribute label="shuffle" title="Shuffle: NetCDF compression parameter"/>
+  <rowAttribute label="defaultPriority" type="xs:integer" title="Indicative priority for this parameter, which is over-ruled by the requestVar priority setting, but provides a reference for organisation of the CMORvariables"/>
   <rowAttribute label="type"/>
-  <rowAttribute label="modeling_realm" class="drsVocab"/>
-  <rowAttribute label="positive" class="CMORdirective"/>
-  <rowAttribute label="mipTable" title="The MIP table: each table identifies a collection of variables" class="drsVocab"/>
+  <rowAttribute label="modeling_realm" useClass="drsVocab"/>
+  <rowAttribute label="positive" useClass="CMORdirective"/>
+  <rowAttribute label="mipTable" title="The MIP table: each table identifies a collection of variables" useClass="drsVocab"/>
   <rowAttribute label="prov"/>
   <rowAttribute label="provNote"/>
-  <rowAttribute label="frequency" title="Frequency of time steps to be archived." class="drsVocab"/>
+  <rowAttribute label="frequency" title="Frequency of time steps to be archived." useClass="drsVocab"/>
   <rowAttribute label="rowIndex" type="xs:integer" title="Row index of entry in source sheet"/>
   <rowAttribute label="description"/>
@@ -43 +44 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
-  <rowAttribute label="spid" class="internalLink" techNote="spatialShape"/>
-  <rowAttribute label="tmid" class="internalLink" techNote="temporalShape"/>
+  <rowAttribute label="uid" useClass="recordId"/>
+  <rowAttribute label="spid" useClass="internalLink" techNote="spatialShape"/>
+  <rowAttribute label="tmid" useClass="internalLink" techNote="temporalShape"/>
   <rowAttribute label="odims"/>
   <rowAttribute label="coords"/>
@@ -59 +60 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
+  <rowAttribute label="uid" useClass="recordId"/>
   <rowAttribute label="dimensions"/>
   <rowAttribute label="shape"/>
@@ -68 +69 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
+  <rowAttribute label="uid" useClass="recordId"/>
   <rowAttribute label="dimensions"/>
   <rowAttribute label="label"/>
@@ -76 +77 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
+  <rowAttribute label="uid" useClass="recordId"/>
   <rowAttribute label="priority" type="xs:integer"/>
-  <rowAttribute label="vid" title="Identifier for MIP Output Variable" class="internalLink" techNote="ovar"/>
-  <rowAttribute label="vgid" title="Identifier for Variable Group" class="internalLink" techNote="requestVarGroup"/>
+  <rowAttribute label="vid" title="Identifier for MIP Output Variable" useClass="internalLink" techNote="ovar"/>
+  <rowAttribute label="vgid" title="Identifier for Variable Group" useClass="internalLink" techNote="requestVarGroup"/>
   <rowAttribute label="mip"/>
   <rowAttribute label="table"/>
@@ -86 +87 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
-  <rowAttribute label="gpid" title="Identifier for CMOR Tables" class="internalLink" techNote="requestVarGroup"/>
+  <rowAttribute label="uid" useClass="recordId"/>
+  <rowAttribute label="gpid" title="Identifier for CMOR Tables" useClass="internalLink" techNote="requestVarGroup"/>
   <rowAttribute label="mip" title="Project"/>
   <rowAttribute label="ref"/>
@@ -95 +96 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
+  <rowAttribute label="uid" useClass="recordId"/>
   <rowAttribute label="mip" title="Endorsed MIP requesting the data"/>
   <rowAttribute label="ref"/>
@@ -103 +104 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
+  <rowAttribute label="uid" useClass="recordId"/>
   <rowAttribute label="mip"/>
   <rowAttribute label="tab"/>
@@ -112 +113 @@
   <rowAttribute label="ref"/>
   <rowAttribute label="refNote"/>
-  <rowAttribute label="refid" title="reference to a request Variable Group" class="internalLink"/>
+  <rowAttribute label="refid" title="reference to a request Variable Group" useClass="internalLink"/>
   <rowAttribute label="opt" title="option for selecting a subset of variables"/>
   <rowAttribute label="opar" title="parameter associated with *opt*"/>
@@ -120 +121 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
+  <rowAttribute label="uid" useClass="recordId"/>
   <rowAttribute label="mip"/>
   <rowAttribute label="tab"/>
   <rowAttribute label="expt"/>
-  <rowAttribute label="rlid" title="Identifier of corresponding requestLink" class="internalLink"/>
-  <rowAttribute label="esid" title="Identifier experiment(s): a link to an experiment, an experiment group or a MIP" class="internalLink"/>
+  <rowAttribute label="rlid" title="Identifier of corresponding requestLink" useClass="internalLink"/>
+  <rowAttribute label="esid" title="Identifier experiment(s): a link to an experiment, an experiment group or a MIP" useClass="internalLink"/>
   <rowAttribute label="esidComment"/>
   <rowAttribute label="ny" type="xs:integer"/>
@@ -135 +136 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" class="recordId"/>
-  <rowAttribute label="tid" title="Target identifier: the record ID of the item this refers to." class="internalLink"/>
+  <rowAttribute label="uid" useClass="recordId"/>
+  <rowAttribute label="tid" title="Target identifier: the record ID of the item this refers to." useClass="internalLink"/>
   <rowAttribute label="tattr" title="Target attribute: an attribute of the target item, or 'ALL'"/>
   <rowAttribute label="description" title="Free text remarks -- unless there are specific restrictions associated with the class attribute of this remark"/>
@@ -147 +148 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
-  <rowAttribute label="description" title="Description" class="freeText"/>
-  <rowAttribute label="egid" title="Identifier for experiment group" class="internalLink"/>
-  <rowAttribute label="mip" title="MIP defining experiment" class="internalLink"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
+  <rowAttribute label="description" title="Description" useClass="freeText"/>
+  <rowAttribute label="egid" title="Identifier for experiment group" useClass="internalLink"/>
+  <rowAttribute label="mip" title="MIP defining experiment" useClass="internalLink"/>
   <rowAttribute label="mcfg" title="Model category"/>
   <rowAttribute label="tier" type="xs:integer" title="Tier of experiment"/>
@@ -164 +165 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
   <rowAttribute label="tierMin" type="xs:integer" title="Minimum tier of experiments in group"/>
   <rowAttribute label="ntot" type="xs:integer" title="Total number of years"/>
@@ -171 +172 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
-  <rowAttribute label="description" title="Description" class="freeText"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
+  <rowAttribute label="description" title="Description" useClass="freeText"/>
   <rowAttribute label="title" title="Long name"/>
   <rowAttribute label="mip" title="Endorsed MIP"/>
@@ -179 +180 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
-  <rowAttribute label="oid" title="Identifier for a scientific objective" class="internalLink" techNote="objective"/>
-  <rowAttribute label="rid" title="Identifier for a request link" class="internalLink" techNote="requestLink"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
+  <rowAttribute label="oid" title="Identifier for a scientific objective" useClass="internalLink" techNote="objective"/>
+  <rowAttribute label="rid" title="Identifier for a request link" useClass="internalLink" techNote="requestLink"/>
 </table>
 <table label="varChoiceLinkR" uid="SECTION:varChoiceLinkR" title="Links a variable to a choice element" id="cmip.drv.016" itemLabelMode="def" level="0" maxOccurs="1" labUnique="Yes">
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
-  <rowAttribute label="vid" title="Variable" class="internalLink"/>
-  <rowAttribute label="cid" title="Choice" class="internalLink"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
+  <rowAttribute label="vid" title="Variable" useClass="internalLink"/>
+  <rowAttribute label="cid" title="Choice" useClass="internalLink"/>
   <rowAttribute label="rank" type="xs:integer" title="For ranked choices, the rank of this variable (higher rank makes lower ranks redundant)"/>
 </table>
@@ -194 +195 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
-  <rowAttribute label="vid" title="Variable" class="internalLink"/>
-  <rowAttribute label="cfgid" title="Configuration Option" class="internalLink"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
+  <rowAttribute label="vid" title="Variable" useClass="internalLink"/>
+  <rowAttribute label="cfgid" title="Configuration Option" useClass="internalLink"/>
   <rowAttribute label="cfg" type="xs:boolean" title="Configuration Value"/>
-  <rowAttribute label="cid" title="Choice -- can provide a link to related variables" class="internalLink"/>
+  <rowAttribute label="cid" title="Choice -- can provide a link to related variables" useClass="internalLink"/>
 </table>
 <table label="varChoice" uid="SECTION:varChoice" title="Indicates variables for which a there is a range of potential CMOR Varibles" id="cmip.drv.018" itemLabelMode="def" level="0" maxOccurs="1" labUnique="Yes">
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
   <rowAttribute label="class" title="Class of choice: heirarchy|cfg"/>
   <rowAttribute label="title"/>
@@ -213 +214 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
   <rowAttribute label="title"/>
   <rowAttribute label="description"/>
@@ -222 +223 @@
   <rowAttribute label="label" title="Record Label"/>
   <rowAttribute label="title" title="Record Title"/>
-  <rowAttribute label="uid" title="Record identifier" class="recordId"/>
+  <rowAttribute label="uid" title="Record identifier" useClass="recordId"/>
   <rowAttribute label="title"/>
   <rowAttribute label="MIPs"/>
@@ -229 +230 @@
   <rowAttribute label="range" title="Range of valid values, e.g. xs:boolean"/>
 </table>
+<table label="standardname" uid="SECTION:standardname" title="CF Standard Names" id="cmip.drv.021" itemLabelMode="an" level="0" maxOccurs="1" labUnique="Yes">
+  <rowAttribute label="label" title="Record Label"/>
+  <rowAttribute label="title" title="Record Title"/>
+  <rowAttribute label="uid" title="CF Standard Name" useClass="recordId"/>
+  <rowAttribute label="description"/>
+  <rowAttribute label="title"/>
+  <rowAttribute label="label"/>
+  <rowAttribute label="units" title="Canonical Units"/>
+</table>
 </defDoc>

CMIP6dreqbuild/trunk/src/framework/ptxt.py

@@ -72 +72 @@
 ial_elTmpl = '  <rowAttribute label="%(label)s"%(wrappedType)s%(wrappedTitle)s%(wrappedClass)s%(wrappedTechn)s/>'
 
-expl_Tmpl = '''<%(label)s uid="%(uid)s" class="vocab" title="%(title)s" id="%(id)s">
+expl_Tmpl = '''<%(label)s uid="%(uid)s" useClass="vocab" title="%(title)s" id="%(id)s">
 <!-- <info srcType="dummy" srcRef="ptxt.py">Dummy entries</info> -->
 %(exampleItem)s
@@ -104 +104 @@
        for i in self.itematts:
          if i.clss != None:
-           wrappedClass = ' class="%s"' % i.clss
+           wrappedClass = ' useClass="%s"' % i.clss
          else:
            wrappedClass = ''

CMIP6dreqbuild/trunk/src/framework/scanDreq.py

@@ -253 +253 @@
    xr_var_ovar[vid].append( i.uid )
    if not inx.var.uid.has_key(vid):
-     print 'missing key:',i.label, i.prov
+     print 'missing key:',i.label, i.prov, vid
      nerr += 1
    else:
@@ -519 +519 @@
         this.removeChild(d)
     for k in mrefs.keys():
+      print '>>>>>>>>>>> ',k
       if len(  mrefs[k] ) == 1:
         tid = mrefs[k][0][2]