#MoonBit CF Ocean

#Capabilities and support boundaries

#Quick start

moon fmt --check
moon check --target all --deny-warn
moon test --target all --deny-warn

moon run cmd/benchmark --target native

moon add hrwqe/cf_ocean

#API examples

#Validate an ocean variable

let dataset = @dataset.OceanDataset::new("cast")
dataset.add_axis(@dataset.CoordinateAxis::new(
  "depth",
  @dataset.DepthAxis,
  "m",
  [0.0, 50.0, 100.0],
))
let temperature = @dataset.DatasetVariable::new(
  "temperature",
  "sea_water_temperature",
  "degree_Celsius",
  ["depth"],
  [3],
  [21.0, 18.5, 16.0],
)
dataset.add_variable(temperature)
let issues = @dataset.validate_dataset(dataset)

#Apply deterministic quality control

let config : @quality.QCConfig = {
  fill_value: Some(-999.0),
  min_value: Some(-2.0),
  max_value: Some(40.0),
  max_delta: Some(5.0),
  flatline_window: 4,
}
let report = @quality.inspect_series(
  "temperature",
  [20.1, 20.2, -999.0, 20.0],
  config,
)
let masked = @quality.qc_mask([20.1, 20.2, -999.0, 20.0], report, -999.0)

#Screen a vertical ocean profile

let samples = [
  @analytics.ProfileQcSample::new(0.0, 20.0, 35.0),
  @analytics.ProfileQcSample::new(50.0, 18.5, 35.2),
]
let report = @analytics.scan_ocean_profile_default(samples)
let ready_for_export = report.is_clean()

#Read a typed NetCDF variable

fn inspect_netcdf(bytes : Array[Byte]) -> Unit {
  match @binary.parse_nc_header(@binary.ByteBuffer::new(bytes)) {
    Some(header) =>
      match @binary.read_nc_variable(bytes, header, "temperature") {
        Some(values, diagnostics) =>
          println("values=" + values.length().to_string() +
            ", diagnostics=" + diagnostics.length().to_string())
        None => println("variable payload is unavailable")
      }
    None => println("invalid NetCDF header")
  }
}

#Package map

src/
├── binary/       NetCDF Classic/CDF-2 buffers, layouts, diagnostics
├── cf/           CF metadata, units, and compliance diagnostics
├── dataset/      axes, grids, profiles, time series, validation, resampling
├── slice/        ranges, 3D/4D indexing, masked and lazy arrays
├── quality/      deterministic observation QC rules and reports
├── analytics/    seawater physics, profile screening, and spatial-temporal calculations
├── benchmark/    reusable deterministic benchmark workloads
├── export/       NetCDF, Zarr v2, CSV, JSON, Parquet-schema helpers
├── lineage/      transformation and provenance records
└── cli/          summaries, validation reports, and benchmark formatting

cmd/benchmark/    executable benchmark entrypoint

#Correctness and known limitations

• The header parser rejects malformed magic/version/truncated headers; binary layout validation reports invalid dimensions, offsets, and truncated variable payloads instead of silently reading past the available byte array.
• NetCDF exporter offsets are computed from the encoded header and payloads are padded to the declared data positions.
• Dataset validation checks axis monotonicity, duplicate axes, dimensions, shapes, and data lengths. Profile resampling supports ascending and descending depth axes with reject or clamp extrapolation.
• Ocean-physics routines expose a conservative input validator and deterministic regression anchors. They are explicitly bounded approximations; use a dedicated TEOS-10/GSW implementation for publication-grade thermodynamics.
• Zarr chunk output is intentionally honest raw f8 data. Metadata never claims compression that the writer has not applied.
• Parquet output is intentionally a schema JSON bridge; use a dedicated Parquet writer when a binary Parquet file is required.

#Tests and CI

moon fmt --check
moon check --target all --deny-warn
moon build --target all
moon test --target all --deny-warn --enable-coverage
moon coverage report -f summary
moon info

#License and source attribution