Metadata-Version: 2.4
Name: r2o-check
Version: 0.1.0
Summary: NCO Implementation Standards v11.0 compliance checker for NOAA operational model code
Project-URL: Homepage, https://github.com/mansurjisan/r2o-check
Project-URL: Repository, https://github.com/mansurjisan/r2o-check
Project-URL: Issues, https://github.com/mansurjisan/r2o-check/issues
Author-email: Mansur Jisan <mansur.jisan@noaa.gov>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: NCO,NOAA,R2O,WCOSS,compliance,linting,operational-models
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
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: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.9
Requires-Dist: click>=8.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=12.0
Provides-Extra: dev
Requires-Dist: mypy>=1.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Requires-Dist: types-pyyaml; extra == 'dev'
Description-Content-Type: text/markdown

# r2o-check

**NCO Implementation Standards v11.0 compliance checker for NOAA operational model code.**

r2o-check is the "nf-core lint for NOAA operational model delivery" — an automated tool that validates your model package against the [NCO WCOSS Implementation Standards v11.0](https://www.nco.ncep.noaa.gov/idsb/implementation_standards/) before you submit to IDSB. It checks directory structure, file naming conventions, environment variables, build system, modulefiles, version files, and ecFlow scripts.

## Quick Start

```bash
pip install r2o-check
r2o-check lint /path/to/your/model/repo
```

## Features

- **31 rules** across 8 categories (structure, naming, environment, build, modules, versions, ecflow)
- **5 repo types**: operational_model, workflow, tool, library, model_source — rules auto-filter
- **4 output formats**: Rich CLI table, JSON, Markdown (PR comments), HTML report
- **Auto-fix**: create missing directories and stub version files
- **GitHub Action**: `uses: mansurjisan/r2o-check/action@v0.1.0`
- **Configurable**: `.r2o-check.yml` for repo type, disabled rules, ecflow settings
- **Offline**: no network access required for core lint

## Documentation

- [Quickstart Guide](docs/quickstart.md)
- [Rules Reference](docs/rules.md)
- [NCO Standards Mapping](docs/nco-standards-mapping.md)
- [Configuration](docs/quickstart.md#configuration)
- [Contributing](CONTRIBUTING.md)

## License

Apache-2.0. See [LICENSE](LICENSE).
