Skip to content

Commit

Permalink
Preparation for release.
Browse files Browse the repository at this point in the history
Add missing check that positive attribute is consistent with sign implied by standard_name from #30
  • Loading branch information
RosalynHatcher committed Mar 21, 2018
1 parent 445c4f7 commit 77f35c5
Show file tree
Hide file tree
Showing 38 changed files with 65 additions and 40 deletions.
12 changes: 12 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
See https://github.com/cedadev/cf-checker/milestones?state=closed for full details of each release.

-----------------------------------------------------------------
## March 2018

CF Checker release 3.1.0

This is a development release to include addition checks for CF-1.7 comformance.

### Other Noteworthy Changes

[#35](https://github.com/cedadev/cf-checker/issues/35): Improve execution speed

[#29](https://github.com/cedadev/cf-checker/issues/29): Include checks against region names table

## 03.05.2017

CF Checker release 3.0.1
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,17 @@ Alternatively, to install from source:

## Running the CF Checker

`cfchecks [-a area_types.xml] [-s standard_names.xml] [-t cache_time_days ] [-v CFVersion] [-x] [--cachedir <dir>] file1 [file2...]`
`cfchecks [-a <area-types.xml>] [-r <regions.xml>] [-s <std_names.xml>] [-v <CFVersion>] [-x] [-t <cache_time_days>] file1 [file2...]`

For further details and for other available command line options please see the help by running `cfchecks -h`

### Environment Variables

The following parameters can be set on the command-line or through environment variables:

1. `CF_STANDARD_NAMES` (or CL option `-s`) : The path or URL to the CF standard names table
2. `CF_AREA_TYPES` or (CL option `-a`) : The path or URL to the CF area types tables
1. `CF_STANDARD_NAMES` or (CL option `-s`) : The path or URL to the CF standard names table
2. `CF_AREA_TYPES` or (CL option `-a`) : The path or URL to the CF area types table
3. `CF_REGION_NAMES` or (CL option `-r`): The path or URL to the CF region names table

### Wrapper script

Expand All @@ -64,7 +67,7 @@ The wrapper is maintained by CEDA and not by NCAS CMS.

### Running the Test script

In the release tarball there is a `test_files` directory containing a `test.sh` script which runs a series of test files through the CF Checker and confirms the checker is working as expected. It is a very elementary system, which will be rewritten soon. Before running it you will need to edit the location of the cfchecker script in the `tests.sh` file:
In the release tarball there is a `test_files` directory containing a `test.sh` script which runs a series of test files through the CF Checker and confirms the checker is working as expected. It is a very elementary system, which will be rewritten soon. Before running it you will need to edit the location of the cfchecks script in the `tests.sh` file:

cfchecker="<location of cfchecks>"

Expand Down
2 changes: 1 addition & 1 deletion src/cfchecker/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '3.0.6-dev'
__version__ = '3.1.0-rc1'
8 changes: 8 additions & 0 deletions src/cfchecker/cfchecks.py
Original file line number Diff line number Diff line change
Expand Up @@ -2664,6 +2664,14 @@ def chkDescription(self, varName):
else:
self._add_error("No region names specified", varName, code="3.3")

if hasattr(var, 'positive'):
# Check that positive attribute is consistent with sign implied by standard_name
if (re.match("height", name, re.I) and not re.match("up", var.positive, re.I)) or \
(re.match("depth", name, re.I) and not re.match("down", var.positive, re.I)):
self._add_warn("Positive attribute inconsistent with sign conventions implied by the standard_name",
varName, code="4.3")


#---------------------------------
def getStringValue(self, varName):
#---------------------------------
Expand Down
2 changes: 1 addition & 1 deletion test_files/CF_1_0_OK.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CF_1_0_OK.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
8 changes: 5 additions & 3 deletions test_files/CF_1_7.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CF_1_7.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.7
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Area Type Table Version 7 (14 March 2018)
Expand All @@ -20,6 +20,8 @@ ERROR: (5): co-ordinate variable not monotonic
------------------
Checking variable: depth
------------------
WARN: (4.3): Positive attribute inconsistent with sign conventions implied by the standard_name
ERROR: (3.1): Units are not consistent with those given in the standard_name table.
ERROR: (5): co-ordinate variable not monotonic

------------------
Expand Down Expand Up @@ -128,6 +130,6 @@ Checking variable: crs
ERROR: (5.6): Attribute longitude_of_prime_meridian of incorrect data type (Appendix F)
ERROR: (5.6): reference_ellipsoid_name, prime_meridian_name, horizontal_datum_name and geographic_crs_name must all be definied if any one is defined

ERRORS detected: 24
WARNINGS given: 3
ERRORS detected: 25
WARNINGS given: 4
INFORMATION messages: 2
Binary file modified test_files/CF_1_7.nc.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion test_files/CRM018_test1.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM018_test1.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM021_test1.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM021_test1.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM024_test1.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM024_test1.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM026_test2.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM026_test2.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM027_test1.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM027_test1.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM027_test2.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM027_test2.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM028_test1.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM028_test1.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM032_test1.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM032_test1.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM033_test1.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM033_test1.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM035.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM035.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM037.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM037.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM038.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM038.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/CRM041.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: CRM041.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/GregRappa.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: GregRappa.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/Trac020_test1.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: Trac020_test1.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/Trac020_test2.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: Trac020_test2.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/Trac022.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: Trac022.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/Trac049_test1.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: Trac049_test1.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.4
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Area Type Table Version 7 (14 March 2018)
Expand Down
2 changes: 1 addition & 1 deletion test_files/Trac049_test2.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: Trac049_test2.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.4
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Area Type Table Version 7 (14 March 2018)
Expand Down
2 changes: 1 addition & 1 deletion test_files/UpgradeVn.pl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# Before running simply alter the variables $checkerVN and
# $standardNameVN as appropriate.
#--------------------------------------------------------------------------
$checkerVN="3.0.6-dev";
$checkerVN="3.1.0-rc1";
$standardNameVN="50 (2018-03-14T11:01:19Z)";
$areaTypeVN="7 (14 March 2018)";

Expand Down
2 changes: 1 addition & 1 deletion test_files/badc_units.check
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

CHECKING NetCDF FILE: badc_units.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)

WARNING (7.1): Data for variable time lies outside cell boundaries
Expand Down
2 changes: 1 addition & 1 deletion test_files/cell_measures.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: cell_measures.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/cell_methods.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: cell_methods.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/complex.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: complex.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/example_5.10.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: example_5.10.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.7
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Area Type Table Version 7 (14 March 2018)
Expand Down
2 changes: 1 addition & 1 deletion test_files/example_6.2.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: example_6.2.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.7
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Area Type Table Version 7 (14 March 2018)
Expand Down
2 changes: 1 addition & 1 deletion test_files/flag_tests.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: flag_tests.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.3
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/formula_terms.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: formula_terms.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/hfogo_O1_labelVariable_KT.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: hfogo_O1_labelVariable_KT.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.0
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Standardized Region Name Table Version 2 (12 June 2013)
Expand Down
2 changes: 1 addition & 1 deletion test_files/issue27.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: issue27.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.6
Using Standard Name Table Version 50 (2018-03-14T11:01:19Z)
Using Area Type Table Version 7 (14 March 2018)
Expand Down
2 changes: 1 addition & 1 deletion test_files/stdName_test.check
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
CHECKING NetCDF FILE: stdName_test.nc
=====================
Using CF Checker Version 3.0.6-dev
Using CF Checker Version 3.1.0-rc1
Checking against CF Version CF-1.7
Using Standard Name Table Version 2 (2006-09-26T18:12:43Z)
Using Area Type Table Version 7 (14 March 2018)
Expand Down

0 comments on commit 77f35c5

Please sign in to comment.