Mercurial > public > scc-netcdf-checker / annotate
README.rst@5fa09a129470 (annotated)
README.rst
Fri, 10 Oct 2014 15:04:40 +0200
- author
- Iannis <ulalume3@yahoo.com>
- date
- Fri, 10 Oct 2014 15:04:40 +0200
- changeset 3
- 5fa09a129470
- parent 1
- 32fdf3d52505
- permissions
- -rw-r--r--
Merge from 1:32fdf3d52505
| ulalume3@1 | 1 | EARLIENT netcdf format checker |
| ulalume3@1 | 2 | ------------------------------ |
| ulalume3@1 | 3 | |
| ulalume3@1 | 4 | The aim of this script is to check if a netcdf file has the correct |
| ulalume3@1 | 5 | format to be used with the EARLINET's Single Calculus Chain. |
| ulalume3@1 | 6 | |
| ulalume3@1 | 7 | It can check raw lidar data format as well as ancillary file format |
| ulalume3@1 | 8 | i.e. overlap, sounding, and lidar ratio files. |
| ulalume3@1 | 9 | |
| ulalume3@1 | 10 | |
| ulalume3@1 | 11 | .. note:: |
| ulalume3@1 | 12 | This script can help you detect some usual mistakes, but does |
| ulalume3@1 | 13 | not necessarily detect all possible errors in the files. In other |
| ulalume3@1 | 14 | words, your file might look OK through this script but still give |
| ulalume3@1 | 15 | errors when used in the SCC. In that case please let me know to add |
| ulalume3@1 | 16 | the appropriate checks in the specifications. |
| ulalume3@1 | 17 | |
| ulalume3@1 | 18 | |
| ulalume3@1 | 19 | Dependencies |
| ulalume3@1 | 20 | ~~~~~~~~~~~~ |
| ulalume3@1 | 21 | You need to have the netCDF4 python module installed. |
| ulalume3@1 | 22 | |
| ulalume3@1 | 23 | https://pypi.python.org/pypi/netCDF4/ |
| ulalume3@1 | 24 | |
| ulalume3@1 | 25 | |
| ulalume3@1 | 26 | Command line options |
| ulalume3@1 | 27 | ~~~~~~~~~~~~~~~~~~~~ |
| ulalume3@1 | 28 | |
| ulalume3@1 | 29 | Using the -h option in the command line, you can see the following instructions:: |
| ulalume3@1 | 30 | |
| ulalume3@1 | 31 | usage: netcdf_checker.py [-h] [-s {data,overlap,lidar_ratio,sounding}] |
| ulalume3@1 | 32 | [-l {error,warning,notification}] |
| ulalume3@1 | 33 | file |
| ulalume3@1 | 34 | positional arguments: |
| ulalume3@1 | 35 | file The path of the file to be checked |
| ulalume3@1 | 36 | |
| ulalume3@1 | 37 | optional arguments: |
| ulalume3@1 | 38 | -h, --help show this help message and exit |
| ulalume3@1 | 39 | -s {data,overlap,lidar_ratio,sounding}, --specs {data,overlap,lidar_ratio,sounding} |
| ulalume3@1 | 40 | The specificiations to use |
| ulalume3@1 | 41 | -l {error,warning,notification}, --level {error,warning,notification} |
| ulalume3@1 | 42 | The output level |
| ulalume3@1 | 43 | |
| ulalume3@1 | 44 | Examples |
| ulalume3@1 | 45 | ~~~~~~~~ |
| ulalume3@1 | 46 | |
| ulalume3@1 | 47 | Check the format of a data file:: |
| ulalume3@1 | 48 | |
| ulalume3@1 | 49 | python netcdf_checker.py 20140101bu00.nc |
| ulalume3@1 | 50 | |
| ulalume3@1 | 51 | Check the format of a overlap file:: |
| ulalume3@1 | 52 | |
| ulalume3@1 | 53 | python netcdf_checker.py ov_20140101bu00.nc -s overlap |
| ulalume3@1 | 54 | |
| ulalume3@1 | 55 | Check a data file and print all messages, including notifications:: |
| ulalume3@1 | 56 | |
| ulalume3@1 | 57 | python netcdf_checker.py 20140101bu00.nc -l notification |
