Skip to main content

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

Project description

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 before you submit to IDSB. It checks directory structure, file naming conventions, environment variables, build system, modulefiles, version files, and ecFlow scripts.

Quick Start

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

License

Apache-2.0. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

r2o_check-0.1.0.tar.gz (46.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

r2o_check-0.1.0-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

Details for the file r2o_check-0.1.0.tar.gz.

File metadata

  • Download URL: r2o_check-0.1.0.tar.gz
  • Upload date:
  • Size: 46.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for r2o_check-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1f8946af405c894dade7849f85e95a97fe9cce75243ba0709b6bccccc8b20964
MD5 b2eadc2805d2b6ac3a5ed7e3494e87fb
BLAKE2b-256 9967ad994f6ceeb1db7631ca786cedf4e11cb3ea0cac0501d4e38d6fea68554c

See more details on using hashes here.

File details

Details for the file r2o_check-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: r2o_check-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 32.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for r2o_check-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f3b2b0091a921fee4636af5c5006c50e0d54fe4ced6b9a3cb01715ee3de7365
MD5 df719b751b28dee37d22a061a59b74b5
BLAKE2b-256 0ef291946c13ae3d61f539ce34f2adb5d0b04e3902c0861e159a567a4d277f4b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page