Skip to content

KonkovDV/OpenRebar

BranchesTags

Repository files navigation

OpenRebar — Reinforcement Automation for RC Slabs

CI OpenSSF Scorecard .NET 8 License: MIT

English | Русский

OpenRebar is a .NET 8 codebase for generating reinforcement layouts for flat RC slabs from isoline-based inputs (DXF or PNG). The repository is designed to keep the engineering logic testable outside Revit while still supporting a Revit 2025 plugin boundary.

This repo ships three execution surfaces:

  • CLI host (src/OpenRebar.Cli) — batch runs, CI, debugging, integration artifacts
  • Revit host (src/OpenRebar.RevitPlugin) — external command + UI (compiled only when Revit SDK references are available)
  • Optional ML module (ml/) — U-Net segmentation for PNG isolines exposed via HTTP (FastAPI)

Table of Contents

Quick Start (CI-Parity)

Prerequisites:

  • .NET SDK 8.x
  • Python 3.11+ (for tools/ci/*.py and optional ml/ lane)
  • Git with LF-aware checkout

Run from repository root:

dotnet restore OpenRebar.sln --locked-mode -p:EnableWindowsTargeting=true
dotnet build OpenRebar.sln --no-restore --configuration Release -p:EnableWindowsTargeting=true
dotnet format OpenRebar.sln --verify-no-changes --no-restore
dotnet test OpenRebar.sln --no-build --configuration Release
python tools/ci/verify_readme_regression_claim.py

This sequence mirrors the core .NET lane in CI and is the recommended pre-PR minimum for code or docs claims touching test status.

Problem Statement

The motivating workflow is reinforcement placement in Revit from isoline maps exported by tools such as LIRA-SAPR / Stark-ES. Manual placement is time-consuming and susceptible to inconsistency across floors, zones, and engineers.

OpenRebar implements a reproducible pipeline:

  1. Parse an isoline file (DXF or PNG) into color-coded reinforcement zones
  2. Classify zones and decompose complex polygons into rectangles (with persisted coverage/over-coverage evidence)
  3. Calculate reinforcement layout per zone (spacing, diameter, anchorage rules)
  4. Optimize cutting (1D CSP) to reduce waste (exact small-instance path + column-generation baseline for larger instances)
  5. Persist auditable machine-readable artifacts for downstream BIM systems
  6. (When enabled) place shape-driven Rebar elements in Revit and generate tags / bending-shape tracking

The target is to reduce routine slab reinforcement placement from engineer-weeks to engineer-hours under validated assumptions and with a stable, reviewable output contract.

Outputs and Integration Contract

The repository treats the machine-readable outputs as first-class artifacts.

Artifact Produced by Purpose
*.result.json Pipeline / CLI Canonical reinforcement execution report (schema-backed)
*.aerobim.json CLI exporter AeroBIM-oriented summary export
*.schedule.csv CLI exporter Rebar schedule export for downstream spreadsheets/ERP
*.reinforcement.ifc CLI exporter IFC export surface (IFC4 via xBIM)

Canonical schema: contracts/aerobim-reinforcement-report.schema.json (schemaVersion 1.2.0)

The canonical report explicitly persists:

  • normativeProfile (for example ru.sp63.2018) and a versioned table-set id (for example ru.sp63.2018.tables.v1)
  • analysisProvenance for geometry decomposition and cutting optimisation (algorithm ids, thresholds, and fallbacks)
  • per-cutting-plan sawCutWidthMm, so downstream consumers can independently recompute kerf-aware wasteMm / wastePercent
  • per-diameter dualBound / gap quality-bound telemetry when available from the optimizer; heuristic fallback-master runs intentionally suppress these fields (null) because LP lower-bound guarantees do not apply

Architecture

Clean Architecture with strict dependency inversion:

Domain (pure) ← Application (use cases) ← Infrastructure (adapters) ← Hosts (CLI, RevitPlugin)
  • Domain (src/OpenRebar.Domain): models, ports (interfaces), rules; no external dependencies
  • Application (src/OpenRebar.Application): orchestration and use cases; depends only on Domain
  • Infrastructure (src/OpenRebar.Infrastructure): DXF/PNG parsing, optimisation, exports, report store, logging adapter; depends on Domain + Application
  • Hosts:
    • CLI (src/OpenRebar.Cli)
    • Revit plugin (src/OpenRebar.RevitPlugin, #if REVIT_SDK)

Domain Ports

Ports are defined in src/OpenRebar.Domain/Ports/.

Port Responsibility
IIsolineParser Parse DXF/PNG isolines into zones
ILegendLoader Load legend configuration or provide defaults
IZoneDetector Zone classification and polygon decomposition
IReinforcementCalculator Generate rebar segments per zone
IRebarOptimizer Cutting stock optimisation (1D CSP)
ISupplierCatalogLoader Load available stock lengths / pricing
IReportStore Persist canonical *.result.json execution reports
IReportExporter Export external-system reports (for example AeroBIM)
IScheduleExporter Export rebar schedule (CSV)
IIfcExporter Export IFC artefacts
IRevitPlacer Place rebars in an active Revit document
IImageSegmentationService ML-backed PNG segmentation bridge (HTTP)
IStructuredLogger Minimal structured logging abstraction (host-friendly)

Key Implemented Surfaces

Normative Engine (SP 63.13330.2018)

The current normative basis is packaged as a versioned embedded profile resource, with golden tests covering:

  • bond stress / design strength lookup
  • periodic-profile classification
  • linear mass tables

Cutting Optimisation

Two optimiser implementations behind IRebarOptimizer:

Algorithm Intended role
ColumnGenerationOptimizer Production-oriented baseline with persisted optimisation provenance and an exact small-instance fast path
FirstFitDecreasingOptimizer Heuristic baseline and fallback

The column-generation implementation should be understood as a strong engineering baseline (LP/pricing/repair), not as a mathematically complete branch-and-price solver. This distinction is persisted into the canonical report provenance. Reported WasteMm / WastePercent are kerf-aware: they measure residual stock after both installed rebar length and saw-cut material loss are subtracted.

DXF/PNG Color Recognition

  • DXF: AutoCAD ACI palette (256 colors) + ByLayer resolution
  • PNG: CIE L*a*b* ΔE*76 color matching (ISO/CIE 11664-4)
  • Optional ML segmentation for PNG via FastAPI (ml/)

Build and Test

dotnet restore OpenRebar.sln --locked-mode -p:EnableWindowsTargeting=true
dotnet build OpenRebar.sln --no-restore --configuration Release -p:EnableWindowsTargeting=true
dotnet format OpenRebar.sln --verify-no-changes --no-restore
dotnet test OpenRebar.sln --no-build --configuration Release

Current regression status (local dotnet test OpenRebar.sln --configuration Release): 193/193 tests passing.

CI Quality Gates

The build-and-test workflow enforces claim-driven checks, not only compilation:

Gate Purpose Failure effect
dotnet restore --locked-mode lockfile integrity and deterministic dependency graph blocks lane
dotnet build compile-time integrity blocks lane
dotnet format --verify-no-changes --no-restore whitespace/style drift prevention blocks lane
dotnet test + TRX executable regression baseline blocks lane
verify_readme_regression_claim.py README EN/RU test-count claim parity against TRX blocks lane
dependency governance reports supply-chain visibility (--vulnerable, --outdated) evidence artifacts
benchmark summary gate threshold-based quality envelope evidence blocks benchmark lane

For audit-grade closure, use docs/VALIDATION_BASELINE.md.

Comprehensive Audit (2026-04-25)

A full project-wide audit was executed across architecture, algorithmic correctness, build/release reliability, supply-chain security, dependency risk, and documentation quality.

  • Audit report: docs/COMPREHENSIVE_PROJECT_AUDIT_2026_04_25.md
  • Key fix delivered: cost-aware non-regression guard in ColumnGenerationOptimizer with dedicated regression test coverage
  • Follow-up fix delivered: mixed-stock constructive packing for heterogeneous stock catalogs, closing the large-batch single-stock regression and extending benchmark coverage beyond the exact-search envelope
  • Verification baseline: git fsck --full, dotnet build, dotnet test, dotnet list package --vulnerable --include-transitive, and formatting gate check (dotnet format --verify-no-changes)

Optional corpus rail

The manifest-driven corpus rail is intentionally optional. To enable it, add:

  • tests/OpenRebar.Application.Tests/Fixtures/BatchBenchmarkCorpus/manifest.json, or
  • set OPENREBAR_BATCH_CORPUS_ROOT to a directory containing the manifest and fixtures.

CLI Quickstart

dotnet run --project src/OpenRebar.Cli -- <isoline-file> [options]

Common options:

  • --legend <path>: legend configuration (JSON)
  • --catalog <path>: supplier catalog (JSON/CSV)
  • --ml-url <url>: PNG segmentation service (for example http://localhost:8101)
  • --slab-width <mm> / --slab-height <mm> / --thickness <mm> / --cover <mm>

The CLI writes the canonical report next to the input file (.result.json) and also emits .schedule.csv, .aerobim.json, and .reinforcement.ifc exports.

Canonical Examples and Snapshots

The repository now ships canonical reproducible examples under examples/:

  • examples/dxf/simple-slab/input.dxf
  • examples/png/simple-slab/input.png

Each example has committed expected snapshots:

  • expected/input.result.json
  • expected/input.schedule.csv

Regeneration scripts:

# Linux/macOS
bash tools/examples/generate_expected_outputs.sh

# Windows PowerShell
powershell -ExecutionPolicy Bypass -File tools/examples/generate_expected_outputs.ps1

Snapshot verification is executed in ExamplesSnapshotTests (tests/OpenRebar.Application.Tests).

Python ML Module (Optional)

Installation with Supply-Chain Security

The ML module uses cryptographically-verified dependencies to prevent supply-chain attacks:

cd ml

# Install with hash verification (recommended for production)
pip install --require-hashes -r requirements.locked.txt

# Or use the standard requirements (development)
pip install -r requirements.txt

# Run tests
pytest tests -q

# Start segmentation service
uvicorn src.api.server:app --port 8101

Security: See ml/SUPPLY_CHAIN_SECURITY.md for:

  • Dependency lock file with SHA256 hashes
  • Model checkpoint manifest at ml/models/MANIFEST.json with integrity verification
  • CI/CD verification procedures
  • Weekly dependency re-pinning workflow

CI executes the Python smoke tests with an explicit PYTHONPATH pointing to ml/ and installs dependencies from ml/requirements.locked.txt using --require-hashes.

Revit Host Boundary

The Revit host is compiled under #if REVIT_SDK and requires local Autodesk Revit references. The repository includes:

  • DI composition root (src/OpenRebar.RevitPlugin/Bootstrap.cs)
  • placement implementation using Rebar.CreateFromCurves
  • tag creation pass (IndependentTag.Create)
  • bending-shape tracking (element creation is intentionally left as an explicit TODO boundary)

Project Docs

Documentation Governance

To keep public claims and internal evidence aligned:

  1. Update canonical surfaces first (README.md, README.ru.md, docs/VALIDATION_BASELINE.md, docs/README.md).
  2. Keep historical numbers dated in roadmap/audit docs; keep only current numbers in active claim surfaces.
  3. If behavior changed, update command examples and CI-parity guidance in the same change.
  4. Treat report snapshots as dated evidence, not evergreen truth.

Scientific Reporting Standard

Claim Boundary

This README distinguishes implemented and verified behavior from roadmap intent.

  • Verified statements map to executable code paths, contracts, tests, and persisted reports.
  • Planned work remains explicitly framed as future roadmap.
  • Performance and quality metrics are tied to named artifacts and validation lanes, not universal guarantees.

Reproducibility Baseline

Use docs/VALIDATION_BASELINE.md as the canonical validation baseline before publishing engineering or benchmark claims.

Minimum repository baseline:

dotnet build OpenRebar.sln --configuration Release
dotnet test OpenRebar.sln --configuration Release
cd ml
python -m pip install --require-hashes -r requirements.locked.txt
python -m pytest tests -q

If you changed ML dependency governance or workflow behavior, also verify the pinned lock-refresh path documented in docs/VALIDATION_BASELINE.md:

cd ml
python -m pip install --require-hashes -r ..\.github\requirements\pip-tools.locked.txt
python -m piptools compile --allow-unsafe --generate-hashes --output-file=requirements.locked.txt requirements.in

For report-derived claims, include the report file path, schema contract version, and commit SHA.

Citation and Research Reuse

  • Cite software metadata via CITATION.cff.
  • For comparative studies, report both achieved quality indicators and unresolved boundary conditions.
  • Keep normative profile and tables version visible when sharing external evidence.

Governance

License

MIT — see LICENSE.

About

Open-source computational geometry and optimization kernel for automated concrete reinforcement and rebar cutting stock layouts.

Resources

Readme

License

MIT license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages