Compliance Checker Glider DAC plugin
Project description
# GliderDAC Compliance Checker Plugin
[![Build Status](https://travis-ci.org/ioos/cc-plugin-glider.svg?branch=master)](https://travis-ci.org/ioos/cc-plugin-glider)
This [ioos/compliance-checker](https://github.com/ioos/compliance-checker) plugin supports the following sources and standards:
| Standard | Checker Name |
| ---------------------------------------------------------------------------------------------------- | ------------ |
| [Glider DAC](https://github.com/ioos/ioosngdac/wiki/NGDAC-NetCDF-File-Format-Version-2) | gliderdac |
## Installation
### Conda
```shell
$ conda install -c conda-forge cc-plugin-glider
```
### Pip
```shell
$ pip install cc-plugin-glider
```
See the [ioos/compliance-checker](https://github.com/ioos/compliance-checker#installation) for additional Installation notes
## Usage
```shell
$ compliance-checker -l
IOOS compliance checker available checker suites (code version):
...
- gliderdac (x.x.x)
...
$ compliance-checker -t gliderdac [dataset_location]
```
See the [ioos/compliance-checker](https://github.com/ioos/compliance-checker) for additional Usage notes
## Summary of the Checks
The checks have been designed to help data providers submit the highest quality data to the GliderDAC. Submitting uncompliant data to the DAC may result in services not working. For example, not providing the correct Sea Name in the GLobal atttributes may put your glider depoyment into the wrong region on the GliderMap. Not providing proper metadata about the platform and instruments, and attribution may prevent NCEI from archiving your data. And not making your files CF compliant could prevent the files from showing up on ERDDAP and THREDDS servers all together.
### High priority checks
Failures in these checks should be addressed before submitting to the GliderDAC!
- check_required_variables
- check_dimensions
- check_lat_lon_attributes
- check_time_attributes
- check_pressure_depth_attributes
- check_ctd_variable_attributes
- check_profile_variable_attributes_and_types
- check_global_attributes
- check_standard_names
- check_monotonically_increasing_time
- check_dim_no_data
- check_depth_array
### Medium priority checks:
- check_qc_variables
- check_primary_variable_attributes
- check_trajectory_variables
- check_container_variables
- check_qartod
- check_ancillary_variables
- check_dtype
- check_valid_min_dtype
- check_valid_max_dtype
### Low priority checks
- check_ioos_ra
- check_valid_lon
- check_ncei_tables
[![Build Status](https://travis-ci.org/ioos/cc-plugin-glider.svg?branch=master)](https://travis-ci.org/ioos/cc-plugin-glider)
This [ioos/compliance-checker](https://github.com/ioos/compliance-checker) plugin supports the following sources and standards:
| Standard | Checker Name |
| ---------------------------------------------------------------------------------------------------- | ------------ |
| [Glider DAC](https://github.com/ioos/ioosngdac/wiki/NGDAC-NetCDF-File-Format-Version-2) | gliderdac |
## Installation
### Conda
```shell
$ conda install -c conda-forge cc-plugin-glider
```
### Pip
```shell
$ pip install cc-plugin-glider
```
See the [ioos/compliance-checker](https://github.com/ioos/compliance-checker#installation) for additional Installation notes
## Usage
```shell
$ compliance-checker -l
IOOS compliance checker available checker suites (code version):
...
- gliderdac (x.x.x)
...
$ compliance-checker -t gliderdac [dataset_location]
```
See the [ioos/compliance-checker](https://github.com/ioos/compliance-checker) for additional Usage notes
## Summary of the Checks
The checks have been designed to help data providers submit the highest quality data to the GliderDAC. Submitting uncompliant data to the DAC may result in services not working. For example, not providing the correct Sea Name in the GLobal atttributes may put your glider depoyment into the wrong region on the GliderMap. Not providing proper metadata about the platform and instruments, and attribution may prevent NCEI from archiving your data. And not making your files CF compliant could prevent the files from showing up on ERDDAP and THREDDS servers all together.
### High priority checks
Failures in these checks should be addressed before submitting to the GliderDAC!
- check_required_variables
- check_dimensions
- check_lat_lon_attributes
- check_time_attributes
- check_pressure_depth_attributes
- check_ctd_variable_attributes
- check_profile_variable_attributes_and_types
- check_global_attributes
- check_standard_names
- check_monotonically_increasing_time
- check_dim_no_data
- check_depth_array
### Medium priority checks:
- check_qc_variables
- check_primary_variable_attributes
- check_trajectory_variables
- check_container_variables
- check_qartod
- check_ancillary_variables
- check_dtype
- check_valid_min_dtype
- check_valid_max_dtype
### Low priority checks
- check_ioos_ra
- check_valid_lon
- check_ncei_tables
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cc-plugin-glider-2.0.0.tar.gz
(36.4 kB
view details)
File details
Details for the file cc-plugin-glider-2.0.0.tar.gz
.
File metadata
- Download URL: cc-plugin-glider-2.0.0.tar.gz
- Upload date:
- Size: 36.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.23.1 CPython/3.6.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81bbcce049d94c39a200efac4bdf73401263b3b85653dbe1889cb56ee623304a |
|
MD5 | 9e3a931a91825c3030f313e45960da2b |
|
BLAKE2b-256 | 7b3d5dd0597a3b2fcf67b142cba454f5b6c1aa7ffe71f2e68cd8aeb9d5b88cff |