Changes between Initial Version and Version 1 of T02_CSML/Csmlscan


Ignore:
Timestamp:
24/01/08 14:11:48 (13 years ago)
Author:
domlowe
Comment:

Started csml scanner user documentation

Legend:

Unmodified
Added
Removed
Modified
  • T02_CSML/Csmlscan

    v1 v1  
     1 = How to use the CSML Scanner = 
     2 
     3The CSML scanner will scan  a collection of files (or just a single file) to create a CSML Dataset which contains a collection of CSML Features. 
     4 
     5The scanner currently works with !GridSeriesFeatures, e.g. model output, with support for other feature types being under development. 
     6 
     7To install the scanner follow the instructions for installing CSML which start at section 6 here: [wiki:InstallDiscoveryBrowse] 
     8 
     9When CSML is installed you should have a script called csmlscan, which will be somewhere like /usr/local/bin/csmlscan. 
     10 
     11At the command line type: 
     12{{{ 
     13csmlscan 
     14}}} 
     15 
     16You should get an exception: 
     17{{{ 
     18No featuretype declared in config file (or no config file) 
     19}}} 
     20 
     21This shows csmlscan is working, so now we need to create a config file to tell it what to scan. We will then run csmlscan with the -c option to read this config file: 
     22{{{ 
     23csmlscan -c yourconfigfile.cfg 
     24}}} 
     25 
     26 
     27But first, the config file... 
     28 
     29== Example contents of config file == 
     30 
     31{{{ 
     32[dataset] 
     33dsID:UBXyeKx6 
     34 
     35[features] 
     36type: GridSeries 
     37number: many 
     38 
     39[files] 
     40root: /badc/coapec/data/HadCM3_beowulf/64-bit/wholerun/annual/ocean/ 
     41mapping: onetomany 
     42output: /home/dom/coapec/COAPEC_500YrRun_wholerun_annual_ocean.xml 
     43printscreen:1 
     44 
     45[spatialaxes] 
     46spatialstorage:fileextract 
     47 
     48[values] 
     49valuestorage:fileextract 
     50 
     51[time] 
     52timedimension: t 
     53timestorage:inline 
     54 
     55}}}