Metadata-Version: 2.4
Name: cc-plugin-og
Version: 0.1.1
Summary: Open Glider plugin for the IOOS Compliance Checker Plugin
Maintainer-email: Rob Cermak <jcerma@uw.edu>
License: Apache-2.0
Project-URL: documentation, http://ioos.github.io/compliance-checker/
Project-URL: homepage, https://github.com/ioos/cc-plugin-og
Project-URL: repository, https://github.com/ioos/cc-plugin-og
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: compliance-checker>=5.3.0
Requires-Dist: netCDF4
Requires-Dist: pandas
Requires-Dist: tzdata
Requires-Dist: xarray
Dynamic: license-file

# OG Compliance Checker Plugin

[![Default Tests](https://github.com/uw-farlab/cc-plugin-og/actions/workflows/tests.yml/badge.svg)](https://github.com/uw-farlab/cc-plugin-og/actions/workflows/tests.yml)

This is a checker for [OG](https://oceangliderscommunity.github.io/OG-format-user-manual/OG_Format.html) compliance

It works with the [IOOS Compliance Checker](https://github.com/ioos/compliance-checker)

**Note this code is in a pre-release state. Check back soon for the first release**

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Please see LICENSE for the full license text.

For a brief overview of the attributes the OG Checker runs through, check [here](/checks.md).

## Installation

#### Clone this project

Download code and install requirements:
```bash
git clone https://github.com/uw-farlab/cc-plugin-og.git
cd cc-plugin-og
python -m pip install -r requirements.txt
```

Install for general use:
```bash
python -m pip install .
```

Install in an editable method allowing code changes in the source tree to take immediate effect:
```bash
python -m pip install -e .
```

#### Tests should now show up when you run compliance checker
```bash
$ compliance-checker -l

IOOS compliance checker available checker suites (code version):
 - OG (0.0.1-dev)
 - OG:1.0 (0.0.1-dev)
 - OG:latest (0.0.1-dev)
 - acdd (3.1.1)
 - acdd:1.1 (3.1.1)
 - acdd:1.3 (3.1.1)
 - acdd:latest (3.1.1)
 - cf (3.1.1)
 - cf:1.6 (3.1.1)
 - cf:latest (3.1.1)
 - ioos (3.1.1)
 - ioos:0.1 (3.1.1)
 - ioos:1.1 (3.1.1)
 - ioos:latest (3.1.1)
 - ioos_sos (3.1.1)
 - ioos_sos:0.1 (3.1.1)
 - ioos_sos:latest (3.1.1)
 ```

To run this check against an OG netcdf file:

```bash
$ compliance-checker -t og /path/to/file.nc
```
