Changes between Version 4 and Version 5 of T02_CSML/Csmlscan


Ignore:
Timestamp:
30/01/08 11:23:56 (12 years ago)
Author:
domlowe
Comment:

Added csmlscan command argument notes

Legend:

Unmodified
Added
Removed
Modified
  • T02_CSML/Csmlscan

    v4 v5  
    1111At the command line type: 
    1212{{{ 
    13 csmlscan 
     13csmlscan -x 
    1414}}} 
    1515 
    16 You should get an exception: 
     16You should get the following output: 
    1717{{{ 
    18 No featuretype declared in config file (or no config file) 
     18 Starting scan... 
     19 
     20 
     21The following config options have been set: 
     22 
     23 dataset:dsID = None 
     24 
     25 features:type = GridSeries 
     26 
     27 features:minaxes = 2 
     28 
     29 files:root = /your/current/directory 
     30 
     31 files.selection = [] 
     32 
     33 files:mapping = onetomany 
     34 
     35 files:output = csmloutput.xml 
     36 
     37 files:printscreen = 0 
     38 
     39 time:timedimension = time 
     40 
     41 time:timestorage = inline 
     42 
     43 spatialaxes:spatialstorage = fileextract 
     44 
     45 values:valuestorage = fileextract 
     46 
     47 For more information on config options run the command "csmlscan --help" 
     48 
     49 Abandoning scan: remove "-x" flag to scan for real. 
    1950}}} 
    2051 
    21 This 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: 
     52This shows csmlscan is working. Note that the -x flag is useful for checking you the arguments you have passed to csmlscan without actually running a real scan. 
     53 
     54To see the available command line options run: 
     55{{{ 
     56csmlscan --help 
     57}}} 
     58 
     59You will see that one of the available options is '-c' which is used to specify the location of a config file. So csmlscan can either be run directly with command line args, or with the aid of a config file. In some ways a config file is better as you have a record of the request. 
     60 
     61In the following example we will use a config file, but command line arguments could be used instead. 
     62 
     63So we need to create a config file to tell csmlscan what to scan. We will then run csmlscan with the -c option to read this config file: 
    2264{{{ 
    2365csmlscan -c yourconfigfile.cfg 
     
    127169 
    128170If it still doesn't work, then please report a bug, preferably with example data and config file. 
     171 
     172== Defaults == 
     173 
     174If arguments are not supplied, either in a config file or at the command line, then csmlscan has the following defaults: 
     175{{{ 
     176#!python 
     177    DATASETID=None 
     178    MINAXES = 2 
     179    PRINTSCREEN = 0 
     180    MAPPING=None 
     181    OUTPUTFILE='csmloutput.xml' 
     182    TIMEDIMENSION='time' 
     183    TIMESTORAGE='inline' 
     184    VALUESTORAGE='fileextract' 
     185    SPATIALSTORAGE='fileextract' 
     186    FEATURETYPE='GridSeries' 
     187    SELECTION=None 
     188    ROOTDIRECTORY=os.getcwd() 
     189}}} 
     190 
     191Where os.getcwd() is the directory from which you are running csmlscan.