Changeset 180 for CCCC/trunk/README.txt


Ignore:
Timestamp:
30/06/14 12:08:11 (6 years ago)
Author:
mjuckes
Message:

merged from branches-mnj (which was branched from branches-sp)

Location:
CCCC/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • CCCC/trunk

  • CCCC/trunk/README.txt

    r151 r180  
    77Required arguments: 
    88 
    9 python c4.py -p <project> -D <directory>  ## check all files in directory tree, for project in SPECS, CORDEX, CCMI, CMIP5. 
    10 python c4.py -p <project> -d <directory>  ## check all files in directory 
    11 python c4.py -p <project> -f <file>       ## check a single file. 
     9python ceda_cc/c4.py -p <project> -D <directory>  ## check all files in directory tree, for project in SPECS, CORDEX, CCMI, CMIP5. 
     10python ceda_cc/c4.py -p <project> -d <directory>  ## check all files in directory 
     11python ceda_cc/c4.py -p <project> -f <file>       ## check a single file. 
     12python ceda_cc/c4.py --copy-config <dest-dir>     ## copy the default configuration directory to <dest-dir> to enable customisation. 
    1213 
    1314Optional arguments: 
     
    2324  --aMap                # Read in some attribute mappings and run tests with virtual substitutions, see also map2nco.py 
    2425 
     26Environment variables: 
     27 
     28  CC_CONFIG_DIR  ## Set to the location of a custom configuration directory.  If unset the default configuration will be used. 
     29 
    2530After running: 
    2631 
     
    3136This will produce a listing of errors, the number of times they occur and up to two of the files which contain the error. It is hoped that inspection of one or 2 files will provide enough information to trace the problems which lead to the error reports. 
    3237 
     38 
     39Installing as a package: 
     40------------------------ 
     41 
     42You can also install the code into your Python environment and then use the "ceda-cc" command to invoke c4.py with the same arguments ans described above. 
     43 
     44 1. If you have "pip" installed simply execute: 
     45    $ pip install ceda-cc 
     46    or after downloading the tarball 
     47    $ pip install ceda-cc-$VERSION.tar.gz 
     48 
     49 2. If you have the setuptools package you can execute the following from the distribution directory: 
     50    $ python setup.py install 
     51 
     52If you install ceda-cc in this way you can use the --copy-config command to export the default configuration into a directory where you can edit the configuration. 
     53 
     54 
    3355Called from python: 
    3456------------------ 
    3557The code can also be called from a python script: 
    3658 
    37 import c4 
     59from ceda_cc import c4 
    3860m = c4.main( args=argList )     # argList is a python list of command line arguments 
    3961if not m.ok: 
     
    83105 
    84106To update the CMOR tables use:  
    85 "git clone git://uv-cdat.llnl.gov/gitweb/cordex-cmor-tables.git" 
     107"git clone https://github.com/PCMDI/cordex-cmor-tables" 
    86108 
    87109VIRTUAL MODE 
Note: See TracChangeset for help on using the changeset viewer.