Changeset 328


Ignore:
Timestamp:
19/05/15 13:26:42 (5 years ago)
Author:
mjuckes
Message:

Extended documentation

Location:
CCCC/trunk
Files:
12 edited

Legend:

Unmodified
Added
Removed
  • CCCC/trunk/README.txt

    r218 r328  
    2222  --blfmode <mode>      # set mode for batch log file -- see log file modes 
    2323  --flfmode <mode>      # set mode for file-level log file -- see log file modes 
    24   --aMap                # Read in some attribute mappings and run tests with virtual substitutions, see also map2nco.py 
     24  --aMap                # Read in some attribute mappings and run tests with virtual substitutions, see also amap2nco.py 
    2525 
    2626Environment variables: 
  • CCCC/trunk/doc/build/html/_modules/index.html

    r308 r328  
    4646             
    4747  <h1>All modules for which code is available</h1> 
    48 <ul><li><a href="utils_c4.html">utils_c4</a></li> 
     48<ul><li><a href="c4.html">c4</a></li> 
     49<li><a href="c4_run.html">c4_run</a></li> 
     50<li><a href="config_c4.html">config_c4</a></li> 
     51<li><a href="utils_c4.html">utils_c4</a></li> 
    4952<li><a href="xceptions.html">xceptions</a></li> 
    5053</ul> 
  • CCCC/trunk/doc/build/html/_modules/utils_c4.html

    r308 r328  
    5757<span class="kn">from</span> <span class="nn">xceptions</span> <span class="kn">import</span> <span class="o">*</span> 
    5858 
     59<span class="k">class</span> <span class="nc">timeInt</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> 
     60 
     61   <span class="n">vc</span> <span class="o">=</span> <span class="p">{</span><span class="s">&#39;gregorian&#39;</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s">&#39;standard&#39;</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s">&#39;proleptic_gregorian&#39;</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s">&#39;noleap&#39;</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> <span class="s">&#39;365_day&#39;</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> <span class="s">&#39;all_leap&#39;</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span> <span class="s">&#39;366_day&#39;</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span> <span class="s">&#39;360_day&#39;</span><span class="p">:</span><span class="mi">3</span><span class="p">,</span> <span class="s">&#39;julian&#39;</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s">&#39;none&#39;</span><span class="p">:</span><span class="bp">None</span><span class="p">}</span> 
     62   <span class="n">mnmx</span> <span class="o">=</span> <span class="p">[</span> <span class="p">(</span><span class="mi">365</span><span class="p">,</span><span class="mi">366</span><span class="p">),(</span><span class="mi">365</span><span class="p">,</span><span class="mi">365</span><span class="p">),(</span><span class="mi">366</span><span class="p">,</span><span class="mi">366</span><span class="p">),(</span><span class="mi">360</span><span class="p">,</span><span class="mi">360</span><span class="p">)</span> <span class="p">]</span> 
     63   <span class="n">mmnmmx</span> <span class="o">=</span> <span class="p">[</span> <span class="p">(</span><span class="mi">28</span><span class="p">,</span><span class="mi">31</span><span class="p">),(</span><span class="mi">28</span><span class="p">,</span><span class="mi">31</span><span class="p">),(</span><span class="mi">29</span><span class="p">,</span><span class="mi">31</span><span class="p">),(</span><span class="mi">30</span><span class="p">,</span><span class="mi">30</span><span class="p">)</span> <span class="p">]</span> 
     64   <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">cal</span><span class="o">=</span><span class="s">&#39;proleptic_gregorian&#39;</span><span class="p">,</span><span class="n">dpymn</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">dpymx</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span><span class="n">dpmmn</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span><span class="n">dpmmx</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span><span class="n">tol</span><span class="o">=</span><span class="mf">1.e-6</span><span class="p">):</span> 
     65     <span class="bp">self</span><span class="o">.</span><span class="n">tol</span> <span class="o">=</span> <span class="n">tol</span> 
     66     <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">vc</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">cal</span><span class="p">)</span> <span class="ow">or</span> <span class="n">cal</span> <span class="o">==</span> <span class="bp">None</span><span class="p">:</span> 
     67       <span class="k">assert</span> <span class="n">dpymx</span> <span class="o">!=</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">dpymn</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">,</span> <span class="s">&#39;If standard calendar is not use, dpymn and dpymx must be set&#39;</span> 
     68       <span class="k">assert</span> <span class="n">dpmmx</span> <span class="o">!=</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">dpmmn</span> <span class="o">!=</span> <span class="bp">None</span><span class="p">,</span> <span class="s">&#39;If standard calendar is not use, dpmmn and dpmmx must be set&#39;</span> 
     69       <span class="bp">self</span><span class="o">.</span><span class="n">dpymn</span> <span class="o">=</span> <span class="n">dpymn</span> <span class="o">-</span> <span class="n">tol</span> 
     70       <span class="bp">self</span><span class="o">.</span><span class="n">dpymx</span> <span class="o">=</span> <span class="n">dpymx</span> <span class="o">+</span> <span class="n">tol</span> 
     71       <span class="bp">self</span><span class="o">.</span><span class="n">dpmmn</span> <span class="o">=</span> <span class="n">dpmmn</span> <span class="o">-</span> <span class="n">tol</span> 
     72       <span class="bp">self</span><span class="o">.</span><span class="n">dpmmx</span> <span class="o">=</span> <span class="n">dpmmx</span> <span class="o">+</span> <span class="n">tol</span> 
     73     <span class="k">else</span><span class="p">:</span> 
     74       <span class="bp">self</span><span class="o">.</span><span class="n">dpymn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mnmx</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">vc</span><span class="p">[</span><span class="n">cal</span><span class="p">]][</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="n">tol</span> 
     75       <span class="bp">self</span><span class="o">.</span><span class="n">dpymx</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mnmx</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">vc</span><span class="p">[</span><span class="n">cal</span><span class="p">]][</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">tol</span> 
     76       <span class="bp">self</span><span class="o">.</span><span class="n">dpmmn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mmnmmx</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">vc</span><span class="p">[</span><span class="n">cal</span><span class="p">]][</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="n">tol</span> 
     77       <span class="bp">self</span><span class="o">.</span><span class="n">dpmmx</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mmnmmx</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">vc</span><span class="p">[</span><span class="n">cal</span><span class="p">]][</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> <span class="n">tol</span> 
     78     <span class="bp">self</span><span class="o">.</span><span class="n">map</span> <span class="o">=</span> <span class="p">{</span> <span class="s">&#39;yr&#39;</span><span class="p">:</span><span class="s">&#39;P1Y&#39;</span><span class="p">,</span><span class="s">&#39;monClim&#39;</span><span class="p">:</span><span class="s">&#39;P1M&#39;</span><span class="p">,</span><span class="s">&#39;mon&#39;</span><span class="p">:</span><span class="s">&#39;P1M&#39;</span><span class="p">,</span><span class="s">&#39;day&#39;</span><span class="p">:</span><span class="s">&#39;P1D&#39;</span><span class="p">,</span><span class="s">&#39;6hr&#39;</span><span class="p">:</span><span class="s">&#39;P6H&#39;</span><span class="p">,</span><span class="s">&#39;3hr&#39;</span><span class="p">:</span><span class="s">&#39;P3H&#39;</span><span class="p">}</span> 
     79     <span class="bp">self</span><span class="o">.</span><span class="n">nd</span> <span class="o">=</span> <span class="p">{</span> <span class="s">&#39;x&#39;</span><span class="p">:</span><span class="s">&#39;y&#39;</span> <span class="p">}</span> 
     80 
     81   <span class="k">def</span> <span class="nf">setUnit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">u</span><span class="p">):</span> 
     82     <span class="k">if</span> <span class="n">u</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;days&#39;</span><span class="p">,</span><span class="s">&#39;months&#39;</span><span class="p">,</span><span class="s">&#39;years&#39;</span><span class="p">]:</span> 
     83         <span class="k">print</span>  <span class="s">&#39;Time unit </span><span class="si">%s</span><span class="s"> not supported&#39;</span> <span class="o">%</span> <span class="n">u</span> 
     84         <span class="bp">self</span><span class="o">.</span><span class="n">u</span> <span class="o">=</span> <span class="bp">None</span> 
     85     <span class="k">else</span><span class="p">:</span> 
     86         <span class="bp">self</span><span class="o">.</span><span class="n">u</span> <span class="o">=</span> <span class="n">u</span> 
     87 
     88   <span class="k">def</span> <span class="nf">chk</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">v</span><span class="p">,</span><span class="n">u</span><span class="p">,</span><span class="n">f</span><span class="p">):</span> 
     89      <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="o">.</span><span class="n">has_key</span><span class="p">(</span><span class="n">f</span><span class="p">):</span> 
     90         <span class="k">return</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="s">&#39;No frequency check available for f = </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">f</span> <span class="p">)</span> 
     91      <span class="k">if</span> <span class="n">u</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;days&#39;</span><span class="p">]:</span> 
     92         <span class="k">return</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="s">&#39;No frequency check available for units = </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">u</span> <span class="p">)</span> 
     93      <span class="n">x</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> 
     94      <span class="k">if</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&#39;P1Y&#39;</span><span class="p">:</span> 
     95        <span class="k">return</span> <span class="p">(</span><span class="n">v</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">dpymn</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="n">v</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">dpymx</span><span class="p">)</span> 
     96      <span class="k">elif</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&#39;P1M&#39;</span><span class="p">:</span> 
     97        <span class="k">return</span> <span class="p">(</span><span class="n">v</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">dpmmn</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="n">v</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">dpmmx</span><span class="p">)</span> 
     98      <span class="k">elif</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&#39;P1D&#39;</span><span class="p">:</span> 
     99        <span class="k">return</span> <span class="p">(</span><span class="n">v</span> <span class="o">&gt;</span> <span class="mf">1.</span><span class="o">-</span><span class="bp">self</span><span class="o">.</span><span class="n">tol</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="n">v</span> <span class="o">&lt;</span> <span class="mf">1.</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">tol</span><span class="p">)</span> 
     100      <span class="k">elif</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&#39;P6H&#39;</span><span class="p">:</span> 
     101        <span class="k">return</span> <span class="p">(</span><span class="n">v</span> <span class="o">&gt;</span> <span class="mf">0.25</span><span class="o">-</span><span class="bp">self</span><span class="o">.</span><span class="n">tol</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="n">v</span> <span class="o">&lt;</span> <span class="mf">0.25</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">tol</span><span class="p">)</span> 
     102      <span class="k">elif</span> <span class="n">x</span> <span class="o">==</span> <span class="s">&#39;P3H&#39;</span><span class="p">:</span> 
     103        <span class="k">return</span> <span class="p">(</span><span class="n">v</span> <span class="o">&gt;</span> <span class="mf">0.125</span><span class="o">-</span><span class="bp">self</span><span class="o">.</span><span class="n">tol</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="n">v</span> <span class="o">&lt;</span> <span class="mf">0.125</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">tol</span><span class="p">)</span> 
     104       
     105 
    59106<span class="k">class</span> <span class="nc">reportSection</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> 
    60107 
     
    300347 
    301348    <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pcfg</span><span class="o">.</span><span class="n">projectV</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;ESA-CCI&#39;</span><span class="p">]:</span> 
    302       <span class="bp">self</span><span class="o">.</span><span class="n">test</span><span class="p">(</span> <span class="s">&#39;ESACCI&#39;</span> <span class="ow">in</span> <span class="n">bits</span><span class="p">[:</span><span class="mi">2</span><span class="p">],</span> <span class="s">&#39;File name not a valid ESA-CCI file name: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">fn</span><span class="p">,</span> <span class="n">abort</span><span class="o">=</span><span class="bp">True</span> <span class="p">)</span> 
    303       <span class="k">if</span> <span class="n">bits</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">&#39;ESACCI&#39;</span><span class="p">:</span> 
     349      <span class="bp">self</span><span class="o">.</span><span class="n">test</span><span class="p">(</span> <span class="s">&#39;ESACCI&#39;</span> <span class="ow">in</span> <span class="n">bits</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span> <span class="ow">or</span> <span class="s">&#39;ESA&#39;</span> <span class="o">==</span> <span class="n">bits</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s">&#39;File name not a valid ESA-CCI file name: </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">fn</span><span class="p">,</span> <span class="n">abort</span><span class="o">=</span><span class="bp">True</span> <span class="p">)</span> 
     350      <span class="k">if</span> <span class="n">bits</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">&#39;ESA&#39;</span><span class="p">:</span> 
     351        <span class="bp">self</span><span class="o">.</span><span class="n">esaFnId</span> <span class="o">=</span> <span class="mi">2</span> 
     352      <span class="k">elif</span> <span class="n">bits</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">&#39;ESACCI&#39;</span><span class="p">:</span> 
    304353        <span class="bp">self</span><span class="o">.</span><span class="n">esaFnId</span> <span class="o">=</span> <span class="mi">1</span> 
    305354      <span class="k">else</span><span class="p">:</span> 
     
    315364    <span class="bp">self</span><span class="o">.</span><span class="n">fnDict</span> <span class="o">=</span> <span class="p">{}</span> 
    316365    <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">pcfg</span><span class="o">.</span><span class="n">projectV</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;ESA-CCI&#39;</span><span class="p">]:</span> 
    317       <span class="n">l0</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span><span class="mi">6</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span><span class="mi">5</span><span class="p">}[</span><span class="bp">self</span><span class="o">.</span><span class="n">esaFnId</span><span class="p">]</span>   
     366      <span class="n">l0</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span><span class="mi">6</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span><span class="mi">5</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span><span class="mi">5</span><span class="p">}[</span><span class="bp">self</span><span class="o">.</span><span class="n">esaFnId</span><span class="p">]</span>   
    318367      <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">l0</span><span class="p">):</span> 
    319368        <span class="n">x</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pcfg</span><span class="o">.</span><span class="n">globalAttributesInFn</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> 
     
    331380          <span class="k">else</span><span class="p">:</span> 
    332381            <span class="bp">self</span><span class="o">.</span><span class="n">fnDict</span><span class="p">[</span><span class="s">&#39;additional&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">bits</span><span class="p">[</span><span class="o">-</span><span class="mi">2</span><span class="p">]</span> 
    333       <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">esaFnId</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> 
     382      <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">esaFnId</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">]:</span> 
    334383        <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">bits</span><span class="p">)</span> <span class="o">==</span> <span class="mi">8</span><span class="p">:</span> 
    335384          <span class="bp">self</span><span class="o">.</span><span class="n">fnDict</span><span class="p">[</span><span class="s">&#39;additional&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">bits</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> 
     
    372421 
    373422        <span class="bp">self</span><span class="o">.</span><span class="n">test</span><span class="p">(</span>  <span class="nb">len</span><span class="p">(</span><span class="n">bits</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">bits</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span> <span class="s">&#39;Start and end time specified in file name [</span><span class="si">%s</span><span class="s">] of unequal length&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fnParts</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="p">),</span> <span class="n">abort</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">part</span><span class="o">=</span><span class="bp">True</span>  <span class="p">)</span> 
     423        <span class="bp">self</span><span class="o">.</span><span class="n">test</span><span class="p">(</span>  <span class="nb">int</span><span class="p">(</span><span class="n">bits</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">&lt;=</span> <span class="nb">int</span><span class="p">(</span><span class="n">bits</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span> <span class="s">&#39;Start and end time specified in file name [</span><span class="si">%s</span><span class="s">] in wrong order&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fnParts</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="p">),</span> <span class="n">abort</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">part</span><span class="o">=</span><span class="bp">True</span>  <span class="p">)</span> 
    374424 
    375425        <span class="k">for</span> <span class="n">b</span> <span class="ow">in</span> <span class="n">bits</span><span class="p">:</span> 
     
    10281078       <span class="k">raise</span> <span class="n">baseException</span><span class="p">(</span> <span class="s">&#39;mipVocab.lists called with bad list specifier </span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">k2</span> <span class="p">)</span> 
    10291079 
    1030   <span class="k">def</span> <span class="nf">isInTable</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">vg</span> <span class="p">):</span> 
     1080  <span class="k">def</span> <span class="nf">isInTable</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">vg1</span> <span class="p">):</span> 
     1081    <span class="n">vg</span> <span class="o">=</span> <span class="n">vg1</span> 
     1082    <span class="k">if</span> <span class="n">vg</span> <span class="o">==</span> <span class="s">&#39;ESA&#39;</span><span class="p">:</span> 
     1083      <span class="n">vg</span> <span class="o">=</span> <span class="s">&#39;ESACCI&#39;</span> 
    10311084    <span class="k">assert</span> <span class="n">vg</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">varcons</span><span class="o">.</span><span class="n">keys</span><span class="p">(),</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s"> not found in  self.varcons.keys() [</span><span class="si">%s</span><span class="s">]&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">vg</span><span class="p">,</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">varcons</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="p">)</span> 
    10321085    <span class="k">return</span> <span class="p">(</span><span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">varcons</span><span class="p">[</span><span class="n">vg</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> 
    10331086       
    1034   <span class="k">def</span> <span class="nf">getAttr</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">vg</span><span class="p">,</span> <span class="n">a</span> <span class="p">):</span> 
     1087  <span class="k">def</span> <span class="nf">getAttr</span><span class="p">(</span> <span class="bp">self</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">vg1</span><span class="p">,</span> <span class="n">a</span> <span class="p">):</span> 
     1088    <span class="n">vg</span> <span class="o">=</span> <span class="n">vg1</span> 
     1089    <span class="k">if</span> <span class="n">vg</span> <span class="o">==</span> <span class="s">&#39;ESA&#39;</span><span class="p">:</span> 
     1090      <span class="n">vg</span> <span class="o">=</span> <span class="s">&#39;ESACCI&#39;</span> 
    10351091    <span class="k">assert</span> <span class="n">vg</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">varcons</span><span class="o">.</span><span class="n">keys</span><span class="p">(),</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s"> not found in  self.varcons.keys()&#39;</span> 
    10361092    <span class="k">assert</span> <span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">varcons</span><span class="p">[</span><span class="n">vg</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">(),</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s"> not found in self.varcons[</span><span class="si">%s</span><span class="s">].keys()&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">v</span><span class="p">,</span><span class="n">vg</span><span class="p">)</span> 
  • CCCC/trunk/doc/build/html/_sources/index.txt

    r308 r328  
    66The ceda-cc file compliance checker: technical documentation  
    77=================================== 
    8  
    9 Contents: 
    108 
    119.. toctree:: 
     
    2119Command line                                   Description 
    2220=============================================  ========================================================== 
    23 ceda-cc -p <project> -D <directory>            check all data in directory tree under specified directory 
    24 ceda-cc -p <project> -d <directory>            check all data in specified directory 
    25 ceda-cc -p <project> -f <file>                 check a single file  
    26 ceda-cc --sum <log file directory>             create an overview of results 
    27 ceda-cc --copy-config-file  <target diectory>  copy configuration files to a new directory 
     21ceda-cc -p <project> -D <directory>  [..]      check all data in directory tree under specified directory 
     22ceda-cc -p <project> -d <directory>  [..]      check all data in specified directory 
     23ceda-cc -p <project> -f <file>       [..]      check a single file  
     24ceda-cc --sum <log file directory>   [..]      create an overview of results 
     25ceda-cc --copy-config  <target diectory> [..]  copy configuration files to a new directory 
    2826=============================================  ========================================================== 
    2927 
     
    3129   :members: 
    3230 
     31c4 
     32=============== 
     33 
     34.. automodule:: c4 
     35   :members: 
     36 
     37 
     38c4_run 
     39=============== 
     40 
     41.. automodule:: c4_run 
     42   :members: 
     43 
     44 
     45config_c4 
     46=============== 
     47 
     48.. automodule:: config_c4 
     49   :members: 
     50 
     51 
    3352utils_c4 
    3453=============== 
    3554 
    3655.. automodule:: utils_c4 
     56   :show-inheritance: 
     57   :inherited-members: 
    3758   :members: 
    3859 
  • CCCC/trunk/doc/build/html/genindex.html

    r308 r328  
    5656 | <a href="#I"><strong>I</strong></a> 
    5757 | <a href="#L"><strong>L</strong></a> 
     58 | <a href="#M"><strong>M</strong></a> 
     59 | <a href="#N"><strong>N</strong></a> 
     60 | <a href="#P"><strong>P</strong></a> 
    5861 | <a href="#R"><strong>R</strong></a> 
    5962 | <a href="#T"><strong>T</strong></a> 
     
    8689  <td style="width: 33%" valign="top"><dl> 
    8790       
     91  <dt><a href="index.html#module-c4">c4 (module)</a> 
     92  </dt> 
     93 
     94       
     95  <dt><a href="index.html#module-c4_run">c4_run (module)</a> 
     96  </dt> 
     97 
     98       
    8899  <dt><a href="index.html#module-ccinit">ccinit (module)</a> 
    89100  </dt> 
     
    123134  </dt> 
    124135 
     136       
     137  <dt><a href="index.html#module-config_c4">config_c4 (module)</a> 
     138  </dt> 
     139 
     140       
     141  <dt><a href="index.html#config_c4.copy_config">copy_config() (in module config_c4)</a> 
     142  </dt> 
     143 
    125144  </dl></td> 
    126145</tr></table> 
     
    155174  </dt> 
    156175 
     176      <dd><dl> 
     177         
     178  <dt><a href="index.html#utils_c4.checkByVar.isInt">(utils_c4.checkByVar method)</a> 
     179  </dt> 
     180 
     181         
     182  <dt><a href="index.html#utils_c4.checkFileName.isInt">(utils_c4.checkFileName method)</a> 
     183  </dt> 
     184 
     185         
     186  <dt><a href="index.html#utils_c4.checkGlobalAttributes.isInt">(utils_c4.checkGlobalAttributes method)</a> 
     187  </dt> 
     188 
     189         
     190  <dt><a href="index.html#utils_c4.checkStandardDims.isInt">(utils_c4.checkStandardDims method)</a> 
     191  </dt> 
     192 
     193      </dl></dd> 
    157194  </dl></td> 
    158195</tr></table> 
     
    165202  </dt> 
    166203 
     204      <dd><dl> 
     205         
     206  <dt><a href="index.html#utils_c4.checkByVar.log_error">(utils_c4.checkByVar method)</a> 
     207  </dt> 
     208 
     209         
     210  <dt><a href="index.html#utils_c4.checkFileName.log_error">(utils_c4.checkFileName method)</a> 
     211  </dt> 
     212 
     213         
     214  <dt><a href="index.html#utils_c4.checkGlobalAttributes.log_error">(utils_c4.checkGlobalAttributes method)</a> 
     215  </dt> 
     216 
     217         
     218  <dt><a href="index.html#utils_c4.checkStandardDims.log_error">(utils_c4.checkStandardDims method)</a> 
     219  </dt> 
     220 
     221      </dl></dd> 
    167222       
    168223  <dt><a href="index.html#utils_c4.checkBase.log_exception">log_exception() (utils_c4.checkBase method)</a> 
    169224  </dt> 
    170225 
     226      <dd><dl> 
     227         
     228  <dt><a href="index.html#utils_c4.checkByVar.log_exception">(utils_c4.checkByVar method)</a> 
     229  </dt> 
     230 
     231         
     232  <dt><a href="index.html#utils_c4.checkFileName.log_exception">(utils_c4.checkFileName method)</a> 
     233  </dt> 
     234 
     235         
     236  <dt><a href="index.html#utils_c4.checkGlobalAttributes.log_exception">(utils_c4.checkGlobalAttributes method)</a> 
     237  </dt> 
     238 
     239         
     240  <dt><a href="index.html#utils_c4.checkStandardDims.log_exception">(utils_c4.checkStandardDims method)</a> 
     241  </dt> 
     242 
     243      </dl></dd> 
    171244       
    172245  <dt><a href="index.html#utils_c4.checkBase.log_pass">log_pass() (utils_c4.checkBase method)</a> 
    173246  </dt> 
    174247 
     248      <dd><dl> 
     249         
     250  <dt><a href="index.html#utils_c4.checkByVar.log_pass">(utils_c4.checkByVar method)</a> 
     251  </dt> 
     252 
     253         
     254  <dt><a href="index.html#utils_c4.checkFileName.log_pass">(utils_c4.checkFileName method)</a> 
     255  </dt> 
     256 
     257         
     258  <dt><a href="index.html#utils_c4.checkGlobalAttributes.log_pass">(utils_c4.checkGlobalAttributes method)</a> 
     259  </dt> 
     260 
     261         
     262  <dt><a href="index.html#utils_c4.checkStandardDims.log_pass">(utils_c4.checkStandardDims method)</a> 
     263  </dt> 
     264 
     265      </dl></dd> 
    175266  </dl></td> 
    176267  <td style="width: 33%" valign="top"><dl> 
     
    183274  </dt> 
    184275 
     276      <dd><dl> 
     277         
     278  <dt><a href="index.html#utils_c4.checkByVar.logMessage">(utils_c4.checkByVar method)</a> 
     279  </dt> 
     280 
     281         
     282  <dt><a href="index.html#utils_c4.checkFileName.logMessage">(utils_c4.checkFileName method)</a> 
     283  </dt> 
     284 
     285         
     286  <dt><a href="index.html#utils_c4.checkGlobalAttributes.logMessage">(utils_c4.checkGlobalAttributes method)</a> 
     287  </dt> 
     288 
     289         
     290  <dt><a href="index.html#utils_c4.checkStandardDims.logMessage">(utils_c4.checkStandardDims method)</a> 
     291  </dt> 
     292 
     293      </dl></dd> 
     294  </dl></td> 
     295</tr></table> 
     296 
     297<h2 id="M">M</h2> 
     298<table style="width: 100%" class="indextable genindextable"><tr> 
     299  <td style="width: 33%" valign="top"><dl> 
     300       
     301  <dt><a href="index.html#c4_run.main">main (class in c4_run)</a> 
     302  </dt> 
     303 
     304  </dl></td> 
     305  <td style="width: 33%" valign="top"><dl> 
     306       
     307  <dt><a href="index.html#c4.main_entry">main_entry() (in module c4)</a> 
     308  </dt> 
     309 
     310  </dl></td> 
     311</tr></table> 
     312 
     313<h2 id="N">N</h2> 
     314<table style="width: 100%" class="indextable genindextable"><tr> 
     315  <td style="width: 33%" valign="top"><dl> 
     316       
     317  <dt><a href="index.html#config_c4.NT_fnParts">NT_fnParts (in module config_c4)</a> 
     318  </dt> 
     319 
     320  </dl></td> 
     321  <td style="width: 33%" valign="top"><dl> 
     322       
     323  <dt><a href="index.html#config_c4.NT_project">NT_project (in module config_c4)</a> 
     324  </dt> 
     325 
     326  </dl></td> 
     327</tr></table> 
     328 
     329<h2 id="P">P</h2> 
     330<table style="width: 100%" class="indextable genindextable"><tr> 
     331  <td style="width: 33%" valign="top"><dl> 
     332       
     333  <dt><a href="index.html#config_c4.projectConfig">projectConfig (class in config_c4)</a> 
     334  </dt> 
     335 
    185336  </dl></td> 
    186337</tr></table> 
     
    190341  <td style="width: 33%" valign="top"><dl> 
    191342       
     343  <dt><a href="index.html#config_c4.readVocab">readVocab (class in config_c4)</a> 
     344  </dt> 
     345 
     346  </dl></td> 
     347  <td style="width: 33%" valign="top"><dl> 
     348       
    192349  <dt><a href="index.html#utils_c4.checkBase.runChecks">runChecks() (utils_c4.checkBase method)</a> 
    193350  </dt> 
    194351 
     352      <dd><dl> 
     353         
     354  <dt><a href="index.html#utils_c4.checkByVar.runChecks">(utils_c4.checkByVar method)</a> 
     355  </dt> 
     356 
     357         
     358  <dt><a href="index.html#utils_c4.checkFileName.runChecks">(utils_c4.checkFileName method)</a> 
     359  </dt> 
     360 
     361         
     362  <dt><a href="index.html#utils_c4.checkGlobalAttributes.runChecks">(utils_c4.checkGlobalAttributes method)</a> 
     363  </dt> 
     364 
     365         
     366  <dt><a href="index.html#utils_c4.checkStandardDims.runChecks">(utils_c4.checkStandardDims method)</a> 
     367  </dt> 
     368 
     369      </dl></dd> 
    195370  </dl></td> 
    196371</tr></table> 
     
    203378  </dt> 
    204379 
     380      <dd><dl> 
     381         
     382  <dt><a href="index.html#utils_c4.checkByVar.test">(utils_c4.checkByVar method)</a> 
     383  </dt> 
     384 
     385         
     386  <dt><a href="index.html#utils_c4.checkFileName.test">(utils_c4.checkFileName method)</a> 
     387  </dt> 
     388 
     389         
     390  <dt><a href="index.html#utils_c4.checkGlobalAttributes.test">(utils_c4.checkGlobalAttributes method)</a> 
     391  </dt> 
     392 
     393         
     394  <dt><a href="index.html#utils_c4.checkStandardDims.test">(utils_c4.checkStandardDims method)</a> 
     395  </dt> 
     396 
     397      </dl></dd> 
    205398  </dl></td> 
    206399</tr></table> 
  • CCCC/trunk/doc/build/html/index.html

    r308 r328  
    4747  <div class="section" id="the-ceda-cc-file-compliance-checker-technical-documentation"> 
    4848<h1>The ceda-cc file compliance checker: technical documentation<a class="headerlink" href="#the-ceda-cc-file-compliance-checker-technical-documentation" title="Permalink to this headline">¶</a></h1> 
    49 <p>Contents:</p> 
    5049<div class="toctree-wrapper compound"> 
    5150<ul class="simple"> 
     
    6867</thead> 
    6968<tbody valign="top"> 
    70 <tr class="row-even"><td>ceda-cc -p &lt;project&gt; -D &lt;directory&gt;</td> 
     69<tr class="row-even"><td>ceda-cc -p &lt;project&gt; -D &lt;directory&gt;  [..]</td> 
    7170<td>check all data in directory tree under specified directory</td> 
    7271</tr> 
    73 <tr class="row-odd"><td>ceda-cc -p &lt;project&gt; -d &lt;directory&gt;</td> 
     72<tr class="row-odd"><td>ceda-cc -p &lt;project&gt; -d &lt;directory&gt;  [..]</td> 
    7473<td>check all data in specified directory</td> 
    7574</tr> 
    76 <tr class="row-even"><td>ceda-cc -p &lt;project&gt; -f &lt;file&gt;</td> 
     75<tr class="row-even"><td>ceda-cc -p &lt;project&gt; -f &lt;file&gt;       [..]</td> 
    7776<td>check a single file</td> 
    7877</tr> 
    79 <tr class="row-odd"><td>ceda-cc &#8211;sum &lt;log file directory&gt;</td> 
     78<tr class="row-odd"><td>ceda-cc &#8211;sum &lt;log file directory&gt;   [..]</td> 
    8079<td>create an overview of results</td> 
    8180</tr> 
    82 <tr class="row-even"><td>ceda-cc &#8211;copy-config-file  &lt;target diectory&gt;</td> 
     81<tr class="row-even"><td>ceda-cc &#8211;copy-config  &lt;target diectory&gt; [..]</td> 
    8382<td>copy configuration files to a new directory</td> 
    8483</tr> 
     
    132131</div> 
    133132</div> 
     133<div class="section" id="module-c4"> 
     134<span id="c4"></span><h1>c4<a class="headerlink" href="#module-c4" title="Permalink to this headline">¶</a></h1> 
     135<div class="section" id="c4-py"> 
     136<h2>c4.py<a class="headerlink" href="#c4-py" title="Permalink to this headline">¶</a></h2> 
     137<p>Entry point for command line usage &#8211; see ccinit for usage information.</p> 
     138<dl class="function"> 
     139<dt id="c4.main_entry"> 
     140<tt class="descclassname">c4.</tt><tt class="descname">main_entry</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/c4.html#main_entry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#c4.main_entry" title="Permalink to this definition">¶</a></dt> 
     141<dd><p>Wrapper around main() for use with setuptools.</p> 
     142</dd></dl> 
     143 
     144</div> 
     145</div> 
     146<div class="section" id="module-c4_run"> 
     147<span id="c4-run"></span><h1>c4_run<a class="headerlink" href="#module-c4_run" title="Permalink to this headline">¶</a></h1> 
     148<div class="section" id="ceda-cc"> 
     149<h2>ceda_cc<a class="headerlink" href="#ceda-cc" title="Permalink to this headline">¶</a></h2> 
     150<p>Entry point for API.</p> 
     151</div> 
     152<div class="section" id="usage"> 
     153<h2>USAGE<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> 
     154<p>c4_run.main( &lt;argument list&gt; )</p> 
     155<dl class="class"> 
     156<dt id="c4_run.main"> 
     157<em class="property">class </em><tt class="descclassname">c4_run.</tt><tt class="descname">main</tt><big>(</big><em>args=None</em>, <em>abortMessageCount=-1</em>, <em>printInfo=False</em>, <em>monitorFileHandles=False</em>, <em>cmdl=None</em><big>)</big><a class="reference internal" href="_modules/c4_run.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#c4_run.main" title="Permalink to this definition">¶</a></dt> 
     158<dd><p>Main entry point for execution.</p> 
     159<p>All compliance tests are completed in the instantiation of a &#8220;main&#8221; object. The object created will contain attributes with test results.</p> 
     160</dd></dl> 
     161 
     162</div> 
     163</div> 
     164<div class="section" id="module-config_c4"> 
     165<span id="config-c4"></span><h1>config_c4<a class="headerlink" href="#module-config_c4" title="Permalink to this headline">¶</a></h1> 
     166<div class="section" id="id1"> 
     167<h2>config_c4<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2> 
     168<p>USAGE: 
     169import config_c4</p> 
     170<p>This module sets some basic variables, including some vocabulary lists.</p> 
     171<dl class="attribute"> 
     172<dt id="config_c4.NT_fnParts"> 
     173<tt class="descclassname">config_c4.</tt><tt class="descname">NT_fnParts</tt><a class="headerlink" href="#config_c4.NT_fnParts" title="Permalink to this definition">¶</a></dt> 
     174<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">fnParts</span></tt></p> 
     175</dd></dl> 
     176 
     177<dl class="attribute"> 
     178<dt id="config_c4.NT_project"> 
     179<tt class="descclassname">config_c4.</tt><tt class="descname">NT_project</tt><a class="headerlink" href="#config_c4.NT_project" title="Permalink to this definition">¶</a></dt> 
     180<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">project</span></tt></p> 
     181</dd></dl> 
     182 
     183<dl class="function"> 
     184<dt id="config_c4.copy_config"> 
     185<tt class="descclassname">config_c4.</tt><tt class="descname">copy_config</tt><big>(</big><em>dest_dir</em><big>)</big><a class="reference internal" href="_modules/config_c4.html#copy_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#config_c4.copy_config" title="Permalink to this definition">¶</a></dt> 
     186<dd><p>Copy the current default configuration directory into a separate directory.</p> 
     187<p>The directory &lt;ceda_cc-package-dir&gt;/config is copied to <cite>dest_dir</cite>. 
     188This is useful when ceda-cc is installed as a Python package and the user may 
     189not know where the config directory is stored.</p> 
     190<table class="docutils field-list" frame="void" rules="none"> 
     191<col class="field-name" /> 
     192<col class="field-body" /> 
     193<tbody valign="top"> 
     194<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dest_dir</strong> &#8211; should be a path to a directory which does not yet exist.   
     195The configuration directory will be copied to this path.</td> 
     196</tr> 
     197</tbody> 
     198</table> 
     199</dd></dl> 
     200 
     201<dl class="class"> 
     202<dt id="config_c4.projectConfig"> 
     203<em class="property">class </em><tt class="descclassname">config_c4.</tt><tt class="descname">projectConfig</tt><big>(</big><em>project</em>, <em>version=-1</em><big>)</big><a class="reference internal" href="_modules/config_c4.html#projectConfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#config_c4.projectConfig" title="Permalink to this definition">¶</a></dt> 
     204<dd><p>projectConfig: 
     205Set project specific configuration options.</p> 
     206<p>pcfg = projectConfig( &lt;project id&gt;[, version=..] )</p> 
     207<p>Creates a &#8220;pcfg&#8221; object which contains attributes used in the code, including vocabulary lists.</p> 
     208</dd></dl> 
     209 
     210<dl class="class"> 
     211<dt id="config_c4.readVocab"> 
     212<em class="property">class </em><tt class="descclassname">config_c4.</tt><tt class="descname">readVocab</tt><big>(</big><em>dir</em><big>)</big><a class="reference internal" href="_modules/config_c4.html#readVocab"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#config_c4.readVocab" title="Permalink to this definition">¶</a></dt> 
     213<dd><p>readVocab: 
     214A general class to read in vocabulary lists (&#8220;code lists&#8221; in ISO 19115 terminology) from a variety of structured text files.</p> 
     215</dd></dl> 
     216 
     217</div> 
     218</div> 
    134219<div class="section" id="module-utils_c4"> 
    135220<span id="utils-c4"></span><h1>utils_c4<a class="headerlink" href="#module-utils_c4" title="Permalink to this headline">¶</a></h1> 
     
    138223<dt id="utils_c4.checkBase"> 
    139224<em class="property">class </em><tt class="descclassname">utils_c4.</tt><tt class="descname">checkBase</tt><big>(</big><em>cls='CORDEX'</em>, <em>reportPass=True</em>, <em>parent=None</em>, <em>monitor=None</em><big>)</big><a class="reference internal" href="_modules/utils_c4.html#checkBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#utils_c4.checkBase" title="Permalink to this definition">¶</a></dt> 
    140 <dd><p>Base class for checks, containing a set of standard methods for managing operation of checks and logging of results</p> 
     225<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 
     226<p>Base class for checks, containing a set of standard methods for managing operation of checks and logging of results</p> 
    141227<dl class="method"> 
    142228<dt id="utils_c4.checkBase.isInt"> 
     
    191277<dt id="utils_c4.checkByVar"> 
    192278<em class="property">class </em><tt class="descclassname">utils_c4.</tt><tt class="descname">checkByVar</tt><big>(</big><em>cls='CORDEX'</em>, <em>reportPass=True</em>, <em>parent=None</em>, <em>monitor=None</em><big>)</big><a class="reference internal" href="_modules/utils_c4.html#checkByVar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#utils_c4.checkByVar" title="Permalink to this definition">¶</a></dt> 
    193 <dd><p>Run some checks on groups of files with a common variable. Checks for continuity of time in group</p> 
     279<dd><p>Bases: <a class="reference internal" href="#utils_c4.checkBase" title="utils_c4.checkBase"><tt class="xref py py-class docutils literal"><span class="pre">utils_c4.checkBase</span></tt></a></p> 
     280<p>Run some checks on groups of files with a common variable. Checks for continuity of time in group</p> 
    194281<dl class="method"> 
    195282<dt id="utils_c4.checkByVar.checkThisTrange"> 
     
    222309</dd></dl> 
    223310 
     311<dl class="method"> 
     312<dt id="utils_c4.checkByVar.isInt"> 
     313<tt class="descname">isInt</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#utils_c4.checkByVar.isInt" title="Permalink to this definition">¶</a></dt> 
     314<dd><p>Check that a string is a representation of an integer</p> 
     315</dd></dl> 
     316 
     317<dl class="method"> 
     318<dt id="utils_c4.checkByVar.logMessage"> 
     319<tt class="descname">logMessage</tt><big>(</big><em>msg</em>, <em>error=False</em><big>)</big><a class="headerlink" href="#utils_c4.checkByVar.logMessage" title="Permalink to this definition">¶</a></dt> 
     320<dd><p>Log messages and count messages</p> 
     321</dd></dl> 
     322 
     323<dl class="method"> 
     324<dt id="utils_c4.checkByVar.log_error"> 
     325<tt class="descname">log_error</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#utils_c4.checkByVar.log_error" title="Permalink to this definition">¶</a></dt> 
     326<dd><p>Create an error log message and call logMessage; count errors;</p> 
     327</dd></dl> 
     328 
     329<dl class="method"> 
     330<dt id="utils_c4.checkByVar.log_exception"> 
     331<tt class="descname">log_exception</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#utils_c4.checkByVar.log_exception" title="Permalink to this definition">¶</a></dt> 
     332<dd><p>Logging of exceptions &#8211; putting trace information in log files</p> 
     333</dd></dl> 
     334 
     335<dl class="method"> 
     336<dt id="utils_c4.checkByVar.log_pass"> 
     337<tt class="descname">log_pass</tt><big>(</big><big>)</big><a class="headerlink" href="#utils_c4.checkByVar.log_pass" title="Permalink to this definition">¶</a></dt> 
     338<dd><p>Create a pass log message and call logMessage; count passes;</p> 
     339</dd></dl> 
     340 
     341<dl class="method"> 
     342<dt id="utils_c4.checkByVar.runChecks"> 
     343<tt class="descname">runChecks</tt><big>(</big><big>)</big><a class="headerlink" href="#utils_c4.checkByVar.runChecks" title="Permalink to this definition">¶</a></dt> 
     344<dd><p>Run all the checks registered in this instance (in self.checks) and handle exceptions</p> 
     345</dd></dl> 
     346 
     347<dl class="method"> 
     348<dt id="utils_c4.checkByVar.test"> 
     349<tt class="descname">test</tt><big>(</big><em>res</em>, <em>msg</em>, <em>abort=False</em>, <em>part=False</em>, <em>appendLogfile=(None</em>, <em>None)</em><big>)</big><a class="headerlink" href="#utils_c4.checkByVar.test" title="Permalink to this definition">¶</a></dt> 
     350<dd><p>Handle test results.  
     351:param res: [True/False] result of test; 
     352:param msg: Message describing the test; 
     353:param abort: {optional} Set True if checks should be aborted when test fails; 
     354:param part: {optional} Set True if this is a component of a test (logging of pass suppressed); 
     355:param appendLogfile: {optional} Allows results to be appended to pre-existing log file;</p> 
     356</dd></dl> 
     357 
    224358</dd></dl> 
    225359 
     
    227361<dt id="utils_c4.checkFileName"> 
    228362<em class="property">class </em><tt class="descclassname">utils_c4.</tt><tt class="descname">checkFileName</tt><big>(</big><em>cls='CORDEX'</em>, <em>reportPass=True</em>, <em>parent=None</em>, <em>monitor=None</em><big>)</big><a class="reference internal" href="_modules/utils_c4.html#checkFileName"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#utils_c4.checkFileName" title="Permalink to this definition">¶</a></dt> 
    229 <dd><p>Check basic syntax of file names (i.e. checks properties of the text string, it does not attempt to access the file). 
     363<dd><p>Bases: <a class="reference internal" href="#utils_c4.checkBase" title="utils_c4.checkBase"><tt class="xref py py-class docutils literal"><span class="pre">utils_c4.checkBase</span></tt></a></p> 
     364<p>Check basic syntax of file names (i.e. checks properties of the text string, it does not attempt to access the file). 
    230365Inherits <a class="reference internal" href="#utils_c4.checkBase" title="utils_c4.checkBase"><tt class="xref py py-class docutils literal"><span class="pre">checkBase</span></tt></a> class. Checks are run by the <a class="reference internal" href="#utils_c4.checkFileName.check" title="utils_c4.checkFileName.check"><tt class="xref py py-meth docutils literal"><span class="pre">check()</span></tt></a> method.</p> 
    231366<dl class="method"> 
     
    252387</dd></dl> 
    253388 
     389<dl class="method"> 
     390<dt id="utils_c4.checkFileName.isInt"> 
     391<tt class="descname">isInt</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#utils_c4.checkFileName.isInt" title="Permalink to this definition">¶</a></dt> 
     392<dd><p>Check that a string is a representation of an integer</p> 
     393</dd></dl> 
     394 
     395<dl class="method"> 
     396<dt id="utils_c4.checkFileName.logMessage"> 
     397<tt class="descname">logMessage</tt><big>(</big><em>msg</em>, <em>error=False</em><big>)</big><a class="headerlink" href="#utils_c4.checkFileName.logMessage" title="Permalink to this definition">¶</a></dt> 
     398<dd><p>Log messages and count messages</p> 
     399</dd></dl> 
     400 
     401<dl class="method"> 
     402<dt id="utils_c4.checkFileName.log_error"> 
     403<tt class="descname">log_error</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#utils_c4.checkFileName.log_error" title="Permalink to this definition">¶</a></dt> 
     404<dd><p>Create an error log message and call logMessage; count errors;</p> 
     405</dd></dl> 
     406 
     407<dl class="method"> 
     408<dt id="utils_c4.checkFileName.log_exception"> 
     409<tt class="descname">log_exception</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#utils_c4.checkFileName.log_exception" title="Permalink to this definition">¶</a></dt> 
     410<dd><p>Logging of exceptions &#8211; putting trace information in log files</p> 
     411</dd></dl> 
     412 
     413<dl class="method"> 
     414<dt id="utils_c4.checkFileName.log_pass"> 
     415<tt class="descname">log_pass</tt><big>(</big><big>)</big><a class="headerlink" href="#utils_c4.checkFileName.log_pass" title="Permalink to this definition">¶</a></dt> 
     416<dd><p>Create a pass log message and call logMessage; count passes;</p> 
     417</dd></dl> 
     418 
     419<dl class="method"> 
     420<dt id="utils_c4.checkFileName.runChecks"> 
     421<tt class="descname">runChecks</tt><big>(</big><big>)</big><a class="headerlink" href="#utils_c4.checkFileName.runChecks" title="Permalink to this definition">¶</a></dt> 
     422<dd><p>Run all the checks registered in this instance (in self.checks) and handle exceptions</p> 
     423</dd></dl> 
     424 
     425<dl class="method"> 
     426<dt id="utils_c4.checkFileName.test"> 
     427<tt class="descname">test</tt><big>(</big><em>res</em>, <em>msg</em>, <em>abort=False</em>, <em>part=False</em>, <em>appendLogfile=(None</em>, <em>None)</em><big>)</big><a class="headerlink" href="#utils_c4.checkFileName.test" title="Permalink to this definition">¶</a></dt> 
     428<dd><p>Handle test results.  
     429:param res: [True/False] result of test; 
     430:param msg: Message describing the test; 
     431:param abort: {optional} Set True if checks should be aborted when test fails; 
     432:param part: {optional} Set True if this is a component of a test (logging of pass suppressed); 
     433:param appendLogfile: {optional} Allows results to be appended to pre-existing log file;</p> 
     434</dd></dl> 
     435 
    254436</dd></dl> 
    255437 
     
    257439<dt id="utils_c4.checkGlobalAttributes"> 
    258440<em class="property">class </em><tt class="descclassname">utils_c4.</tt><tt class="descname">checkGlobalAttributes</tt><big>(</big><em>cls='CORDEX'</em>, <em>reportPass=True</em>, <em>parent=None</em>, <em>monitor=None</em><big>)</big><a class="reference internal" href="_modules/utils_c4.html#checkGlobalAttributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#utils_c4.checkGlobalAttributes" title="Permalink to this definition">¶</a></dt> 
    259 <dd><p>Check global and variable attributes, using tables of valid values</p> 
     441<dd><p>Bases: <a class="reference internal" href="#utils_c4.checkBase" title="utils_c4.checkBase"><tt class="xref py py-class docutils literal"><span class="pre">utils_c4.checkBase</span></tt></a></p> 
     442<p>Check global and variable attributes, using tables of valid values</p> 
     443<dl class="method"> 
     444<dt id="utils_c4.checkGlobalAttributes.isInt"> 
     445<tt class="descname">isInt</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#utils_c4.checkGlobalAttributes.isInt" title="Permalink to this definition">¶</a></dt> 
     446<dd><p>Check that a string is a representation of an integer</p> 
     447</dd></dl> 
     448 
     449<dl class="method"> 
     450<dt id="utils_c4.checkGlobalAttributes.logMessage"> 
     451<tt class="descname">logMessage</tt><big>(</big><em>msg</em>, <em>error=False</em><big>)</big><a class="headerlink" href="#utils_c4.checkGlobalAttributes.logMessage" title="Permalink to this definition">¶</a></dt> 
     452<dd><p>Log messages and count messages</p> 
     453</dd></dl> 
     454 
     455<dl class="method"> 
     456<dt id="utils_c4.checkGlobalAttributes.log_error"> 
     457<tt class="descname">log_error</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#utils_c4.checkGlobalAttributes.log_error" title="Permalink to this definition">¶</a></dt> 
     458<dd><p>Create an error log message and call logMessage; count errors;</p> 
     459</dd></dl> 
     460 
     461<dl class="method"> 
     462<dt id="utils_c4.checkGlobalAttributes.log_exception"> 
     463<tt class="descname">log_exception</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#utils_c4.checkGlobalAttributes.log_exception" title="Permalink to this definition">¶</a></dt> 
     464<dd><p>Logging of exceptions &#8211; putting trace information in log files</p> 
     465</dd></dl> 
     466 
     467<dl class="method"> 
     468<dt id="utils_c4.checkGlobalAttributes.log_pass"> 
     469<tt class="descname">log_pass</tt><big>(</big><big>)</big><a class="headerlink" href="#utils_c4.checkGlobalAttributes.log_pass" title="Permalink to this definition">¶</a></dt> 
     470<dd><p>Create a pass log message and call logMessage; count passes;</p> 
     471</dd></dl> 
     472 
     473<dl class="method"> 
     474<dt id="utils_c4.checkGlobalAttributes.runChecks"> 
     475<tt class="descname">runChecks</tt><big>(</big><big>)</big><a class="headerlink" href="#utils_c4.checkGlobalAttributes.runChecks" title="Permalink to this definition">¶</a></dt> 
     476<dd><p>Run all the checks registered in this instance (in self.checks) and handle exceptions</p> 
     477</dd></dl> 
     478 
     479<dl class="method"> 
     480<dt id="utils_c4.checkGlobalAttributes.test"> 
     481<tt class="descname">test</tt><big>(</big><em>res</em>, <em>msg</em>, <em>abort=False</em>, <em>part=False</em>, <em>appendLogfile=(None</em>, <em>None)</em><big>)</big><a class="headerlink" href="#utils_c4.checkGlobalAttributes.test" title="Permalink to this definition">¶</a></dt> 
     482<dd><p>Handle test results.  
     483:param res: [True/False] result of test; 
     484:param msg: Message describing the test; 
     485:param abort: {optional} Set True if checks should be aborted when test fails; 
     486:param part: {optional} Set True if this is a component of a test (logging of pass suppressed); 
     487:param appendLogfile: {optional} Allows results to be appended to pre-existing log file;</p> 
     488</dd></dl> 
     489 
    260490</dd></dl> 
    261491 
     
    263493<dt id="utils_c4.checkStandardDims"> 
    264494<em class="property">class </em><tt class="descclassname">utils_c4.</tt><tt class="descname">checkStandardDims</tt><big>(</big><em>cls='CORDEX'</em>, <em>reportPass=True</em>, <em>parent=None</em>, <em>monitor=None</em><big>)</big><a class="reference internal" href="_modules/utils_c4.html#checkStandardDims"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#utils_c4.checkStandardDims" title="Permalink to this definition">¶</a></dt> 
    265 <dd><p>Check the dimensions which are defined in the specifications</p> 
     495<dd><p>Bases: <a class="reference internal" href="#utils_c4.checkBase" title="utils_c4.checkBase"><tt class="xref py py-class docutils literal"><span class="pre">utils_c4.checkBase</span></tt></a></p> 
     496<p>Check the dimensions which are defined in the specifications</p> 
     497<dl class="method"> 
     498<dt id="utils_c4.checkStandardDims.isInt"> 
     499<tt class="descname">isInt</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#utils_c4.checkStandardDims.isInt" title="Permalink to this definition">¶</a></dt> 
     500<dd><p>Check that a string is a representation of an integer</p> 
     501</dd></dl> 
     502 
     503<dl class="method"> 
     504<dt id="utils_c4.checkStandardDims.logMessage"> 
     505<tt class="descname">logMessage</tt><big>(</big><em>msg</em>, <em>error=False</em><big>)</big><a class="headerlink" href="#utils_c4.checkStandardDims.logMessage" title="Permalink to this definition">¶</a></dt> 
     506<dd><p>Log messages and count messages</p> 
     507</dd></dl> 
     508 
     509<dl class="method"> 
     510<dt id="utils_c4.checkStandardDims.log_error"> 
     511<tt class="descname">log_error</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#utils_c4.checkStandardDims.log_error" title="Permalink to this definition">¶</a></dt> 
     512<dd><p>Create an error log message and call logMessage; count errors;</p> 
     513</dd></dl> 
     514 
     515<dl class="method"> 
     516<dt id="utils_c4.checkStandardDims.log_exception"> 
     517<tt class="descname">log_exception</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#utils_c4.checkStandardDims.log_exception" title="Permalink to this definition">¶</a></dt> 
     518<dd><p>Logging of exceptions &#8211; putting trace information in log files</p> 
     519</dd></dl> 
     520 
     521<dl class="method"> 
     522<dt id="utils_c4.checkStandardDims.log_pass"> 
     523<tt class="descname">log_pass</tt><big>(</big><big>)</big><a class="headerlink" href="#utils_c4.checkStandardDims.log_pass" title="Permalink to this definition">¶</a></dt> 
     524<dd><p>Create a pass log message and call logMessage; count passes;</p> 
     525</dd></dl> 
     526 
     527<dl class="method"> 
     528<dt id="utils_c4.checkStandardDims.runChecks"> 
     529<tt class="descname">runChecks</tt><big>(</big><big>)</big><a class="headerlink" href="#utils_c4.checkStandardDims.runChecks" title="Permalink to this definition">¶</a></dt> 
     530<dd><p>Run all the checks registered in this instance (in self.checks) and handle exceptions</p> 
     531</dd></dl> 
     532 
     533<dl class="method"> 
     534<dt id="utils_c4.checkStandardDims.test"> 
     535<tt class="descname">test</tt><big>(</big><em>res</em>, <em>msg</em>, <em>abort=False</em>, <em>part=False</em>, <em>appendLogfile=(None</em>, <em>None)</em><big>)</big><a class="headerlink" href="#utils_c4.checkStandardDims.test" title="Permalink to this definition">¶</a></dt> 
     536<dd><p>Handle test results.  
     537:param res: [True/False] result of test; 
     538:param msg: Message describing the test; 
     539:param abort: {optional} Set True if checks should be aborted when test fails; 
     540:param part: {optional} Set True if this is a component of a test (logging of pass suppressed); 
     541:param appendLogfile: {optional} Allows results to be appended to pre-existing log file;</p> 
     542</dd></dl> 
     543 
    266544</dd></dl> 
    267545 
     
    312590</ul> 
    313591</li> 
     592</ul> 
     593</li> 
     594<li><a class="reference internal" href="#module-c4">c4</a><ul> 
     595<li><a class="reference internal" href="#c4-py">c4.py</a></li> 
     596</ul> 
     597</li> 
     598<li><a class="reference internal" href="#module-c4_run">c4_run</a><ul> 
     599<li><a class="reference internal" href="#ceda-cc">ceda_cc</a></li> 
     600<li><a class="reference internal" href="#usage">USAGE</a></li> 
     601</ul> 
     602</li> 
     603<li><a class="reference internal" href="#module-config_c4">config_c4</a><ul> 
     604<li><a class="reference internal" href="#id1">config_c4</a></li> 
    314605</ul> 
    315606</li> 
  • CCCC/trunk/doc/build/html/py-modindex.html

    r308 r328  
    6868       <td></td> 
    6969       <td> 
     70       <a href="index.html#module-c4"><tt class="xref">c4</tt></a></td><td> 
     71       <em></em></td></tr> 
     72     <tr> 
     73       <td></td> 
     74       <td> 
     75       <a href="index.html#module-c4_run"><tt class="xref">c4_run</tt></a></td><td> 
     76       <em></em></td></tr> 
     77     <tr> 
     78       <td></td> 
     79       <td> 
    7080       <a href="index.html#module-ccinit"><tt class="xref">ccinit</tt></a></td><td> 
     81       <em></em></td></tr> 
     82     <tr> 
     83       <td></td> 
     84       <td> 
     85       <a href="index.html#module-config_c4"><tt class="xref">config_c4</tt></a></td><td> 
    7186       <em></em></td></tr> 
    7287     <tr class="pcap"><td></td><td>&nbsp;</td><td></td></tr> 
  • CCCC/trunk/doc/build/html/searchindex.js

    r308 r328  
    1 Search.setIndex({envversion:42,terms:{represent:0,all:0,code:0,identifi:0,execut:0,checktrang:0,text:0,over:0,global:0,standardis:0,obscur:0,syntax:0,netcdf:0,per:0,follow:0,suffer:0,loggedexcept:0,content:0,onli:0,specif:0,group:0,monitor:0,esacci:0,configur:0,except:0,param:0,should:0,identif:0,valid:0,present:0,under:0,aris:0,flfmode:0,match:0,take:0,sourc:0,string:0,read:0,stop:0,multi:0,initi:0,util:0,cannot:0,fall:0,implicitli:0,pre:0,name:0,checkbas:0,level:0,command:0,list:0,integ:0,method:0,provid:0,necessari:0,trap:0,contain:0,do_check_fnextra:0,attribut:0,isint:0,page:0,summari:0,dimens:0,diectori:0,set:0,do_check_fn:0,map:0,some:0,continu:0,see:0,result:0,pass:0,fail:0,close:0,extract:0,appendlogfil:0,append:0,variabl:0,index:0,cmip:0,parent:0,record:0,sum:0,blfmode:0,access:0,substitut:0,version:0,log_error:0,esa:0,"new":0,across:0,common:0,specialist:0,run:0,kei:0,gener:0,checkstandarddim:0,standard:0,checkfilenam:0,base:0,dictionari:0,put:0,path:0,flist:0,valu:0,addit:0,comparison:0,protect:0,constraint:0,alon:0,through:0,manag:0,log_except:0,reportpass:0,cae:0,logic:0,fals:0,chang:0,logmessag:0,baseexcept:0,oper:0,routin:0,rang:0,suffix:0,overview:0,modul:0,number:0,messag:0,second:0,checkbyvar:0,from:0,describ:0,convent:0,caught:0,support:0,regist:0,system:0,been:0,compon:0,start:0,includ:0,basic:0,msg:0,type:0,unrecognis:0,checkglobalattribut:0,log_pass:0,suppress:0,copi:0,search:0,specifi:0,back:0,part:0,pars:0,"catch":0,line:0,"true":0,those:0,count:0,none:0,target:0,impt:0,instanc:0,whether:0,properti:0,tree:0,batch:0,project:0,defin:0,below:0,error:0,loop:0,seri:0,checkthistrang:0,nearest:0,featur:0,creat:0,scan:0,process:0,argument:0,"default":0,abort:0,exist:0,check:0,runcheck:0,form:0,rather:0,self:0,belong:0,when:0,virtual:0,note:0,recognis:0,complex:0,split:0,which:0,presenc:0,test:0,verifi:0,failur:0,config:0,singl:0,critic:0,cordex:0,trace:0,nest:0,after:0,rais:0,amap:0,thi:0,abortcheck:0,data:0,"class":0,handl:0,overwrit:0,attempt:0,consist:0,directori:0,clear:0,later:0,descript:0,inherit:0,doe:0,inform:0,write:0,cci:0,allow:0,time:0,fact:0,latest:0},objtypes:{"0":"py:module","1":"py:method","2":"py:class","3":"py:exception"},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"],"3":["py","exception","Python exception"]},filenames:["index"],titles:["The ceda-cc file compliance checker: technical documentation"],objects:{"":{ccinit:[0,0,0,"-"],utils_c4:[0,0,0,"-"],xceptions:[0,0,0,"-"]},utils_c4:{checkByVar:[0,2,1,""],checkStandardDims:[0,2,1,""],checkFileName:[0,2,1,""],checkGlobalAttributes:[0,2,1,""],checkBase:[0,2,1,""]},"utils_c4.checkBase":{log_pass:[0,1,1,""],isInt:[0,1,1,""],log_exception:[0,1,1,""],runChecks:[0,1,1,""],log_error:[0,1,1,""],test:[0,1,1,""],logMessage:[0,1,1,""]},xceptions:{abortChecks:[0,3,1,""],loggedException:[0,3,1,""],baseException:[0,3,1,""]},"utils_c4.checkFileName":{do_check_fnextra:[0,1,1,""],check:[0,1,1,""],do_check_fn:[0,1,1,""]},"utils_c4.checkByVar":{checkThisTrange:[0,1,1,""],checkTrange:[0,1,1,""],impt:[0,1,1,""]}},titleterms:{log:0,utils_c4:0,ceda:0,ccinit:0,usag:0,indic:0,complianc:0,checker:0,call:0,mode:0,file:0,tabl:0,xception:0,document:0,technic:0,option:0}}) 
     1Search.setIndex({envversion:42,terms:{represent:0,all:0,code:0,identifi:0,execut:0,checktrang:0,text:0,over:0,global:0,standardis:0,obscur:0,syntax:0,netcdf:0,per:0,follow:0,suffer:0,loggedexcept:0,pcfg:0,nt_fnpart:0,access:0,onli:0,specif:0,group:0,monitor:0,esacci:0,configur:0,except:0,param:0,should:0,identif:0,complex:0,those:0,under:0,dest_dir:0,aris:0,flfmode:0,main:0,match:0,split:0,checkthistrang:0,sourc:0,string:0,read:0,stop:0,none:0,initi:0,util:0,cannot:0,know:0,fall:0,implicitli:0,common:0,ceda_cc:[],name:0,checkbas:0,level:0,list:0,integ:0,across:0,separ:0,whether:0,necessari:0,trap:0,contain:0,do_check_fnextra:0,record:0,where:0,page:0,dir:0,summari:0,dimens:0,diectori:0,set:0,do_check_fn:0,printinfo:0,some:0,continu:0,batch:0,abortmessagecount:0,see:0,result:0,pass:0,fail:0,close:0,extract:0,append:0,variabl:0,index:0,cmip:0,kei:0,appendlogfil:0,sum:0,blfmode:0,yet:0,content:[],substitut:0,version:0,log_error:0,esa:0,"new":0,paramet:0,method:0,attribut:0,specialist:0,after:0,run:0,parent:0,gener:0,checkstandarddim:0,standard:0,checkfilenam:0,base:0,dictionari:0,put:0,path:0,flist:0,valu:0,addit:0,readvocab:0,comparison:0,protect:0,constraint:0,current:0,alon:0,through:0,manag:0,log_except:0,reportpass:0,iso:0,loop:0,logic:0,fals:0,chang:0,logmessag:0,caught:0,nt_project:0,amap:0,oper:0,routin:0,rang:0,suffix:0,point:0,instanti:0,overview:0,modul:0,number:0,terminolog:0,api:0,been:0,"import":0,checkbyvar:0,from:0,describ:0,convent:0,baseexcept:0,support:0,regist:0,system:0,messag:0,compon:0,start:0,includ:0,basic:0,msg:0,type:0,unrecognis:0,store:0,checkglobalattribut:0,wrapper:0,log_pass:0,python:0,suppress:0,copi:0,setuptool:0,search:0,specifi:0,back:0,cmdl:0,part:0,pars:0,presenc:0,"catch":0,line:0,"true":0,present:0,count:0,multi:0,target:0,impt:0,instanc:0,provid:0,alia:0,properti:0,tree:0,second:0,structur:0,project:0,defin:0,below:0,error:0,cae:0,seri:0,pre:0,nearest:0,copy_config:0,creat:0,scan:0,process:0,arg:0,argument:0,projectconfig:0,packag:0,critic:0,abort:0,exist:0,trace:0,featur:0,check:0,around:0,main_entri:0,runcheck:0,form:0,rather:0,allow:0,self:0,belong:0,when:0,virtual:0,instal:0,note:0,recognis:0,valid:0,take:0,which:0,varieti:0,test:0,verifi:0,failur:0,config:0,singl:0,complet:0,map:0,cordex:0,isint:0,"default":0,nest:0,object:0,fnpart:0,monitorfilehandl:0,cci:0,rais:0,user:0,vocabulari:0,mai:0,abortcheck:0,data:0,"class":0,handl:0,overwrit:0,attempt:0,consist:0,directori:0,entri:0,clear:0,later:0,descript:0,inherit:0,doe:0,inform:0,write:0,command:0,thi:0,time:0,fact:0,latest:0},objtypes:{"0":"py:module","1":"py:method","2":"py:class","3":"py:function","4":"py:exception","5":"py:attribute"},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"],"3":["py","function","Python function"],"4":["py","exception","Python exception"],"5":["py","attribute","Python attribute"]},filenames:["index"],titles:["The ceda-cc file compliance checker: technical documentation"],objects:{"":{utils_c4:[0,0,0,"-"],c4_run:[0,0,0,"-"],ccinit:[0,0,0,"-"],xceptions:[0,0,0,"-"],config_c4:[0,0,0,"-"],c4:[0,0,0,"-"]},"utils_c4.checkStandardDims":{isInt:[0,1,1,""],log_pass:[0,1,1,""],log_exception:[0,1,1,""],runChecks:[0,1,1,""],log_error:[0,1,1,""],test:[0,1,1,""],logMessage:[0,1,1,""]},utils_c4:{checkByVar:[0,2,1,""],checkStandardDims:[0,2,1,""],checkFileName:[0,2,1,""],checkGlobalAttributes:[0,2,1,""],checkBase:[0,2,1,""]},"utils_c4.checkBase":{isInt:[0,1,1,""],log_pass:[0,1,1,""],log_exception:[0,1,1,""],runChecks:[0,1,1,""],log_error:[0,1,1,""],test:[0,1,1,""],logMessage:[0,1,1,""]},"utils_c4.checkGlobalAttributes":{log_pass:[0,1,1,""],isInt:[0,1,1,""],log_exception:[0,1,1,""],runChecks:[0,1,1,""],log_error:[0,1,1,""],test:[0,1,1,""],logMessage:[0,1,1,""]},xceptions:{loggedException:[0,4,1,""],abortChecks:[0,4,1,""],baseException:[0,4,1,""]},config_c4:{readVocab:[0,2,1,""],projectConfig:[0,2,1,""],copy_config:[0,3,1,""],NT_fnParts:[0,5,1,""],NT_project:[0,5,1,""]},c4_run:{main:[0,2,1,""]},"utils_c4.checkFileName":{log_pass:[0,1,1,""],isInt:[0,1,1,""],do_check_fn:[0,1,1,""],runChecks:[0,1,1,""],log_exception:[0,1,1,""],log_error:[0,1,1,""],logMessage:[0,1,1,""],test:[0,1,1,""],do_check_fnextra:[0,1,1,""],check:[0,1,1,""]},"utils_c4.checkByVar":{checkThisTrange:[0,1,1,""],impt:[0,1,1,""],log_pass:[0,1,1,""],isInt:[0,1,1,""],checkTrange:[0,1,1,""],log_exception:[0,1,1,""],runChecks:[0,1,1,""],log_error:[0,1,1,""],test:[0,1,1,""],logMessage:[0,1,1,""]},c4:{main_entry:[0,3,1,""]}},titleterms:{ceda_cc:0,utils_c4:0,log:0,c4_run:0,ccinit:0,option:0,usag:0,config_c4:0,indic:0,ceda:0,checker:0,call:0,mode:0,file:0,tabl:0,xception:0,document:0,technic:0,complianc:0}}) 
  • CCCC/trunk/doc/source/index.rst

    r308 r328  
    66The ceda-cc file compliance checker: technical documentation  
    77=================================== 
    8  
    9 Contents: 
    108 
    119.. toctree:: 
     
    3129   :members: 
    3230 
     31c4 
     32=============== 
     33 
     34.. automodule:: c4 
     35   :members: 
     36 
     37 
     38c4_run 
     39=============== 
     40 
     41.. automodule:: c4_run 
     42   :members: 
     43 
     44 
     45config_c4 
     46=============== 
     47 
     48.. automodule:: config_c4 
     49   :members: 
     50 
     51 
    3352utils_c4 
    3453=============== 
    3554 
    3655.. automodule:: utils_c4 
     56   :show-inheritance: 
     57   :inherited-members: 
    3758   :members: 
    3859 
Note: See TracChangeset for help on using the changeset viewer.