Project Overview

ARC Data Model is the workspace for the unified ARC RDM data model. It contains the markdown specification, derived schemas, example documents, reference material from upstream ARC/RO-Crate work, and F# implementation projects for ProcessCore and the SQL profile.

Repository Shape

ARC-Data-Model/
|-- docs/                 fsdocs documentation pages
|   `-- spec/             ARC Process Core, datamap, and administrative specs
|-- schemas/              derived SQL and YAML schema representations
|-- examples/             concrete YAML examples
|-- references/           upstream and prior implementation reference material
|-- src/                  F# libraries
|-- tests/                Pyxpecto test project
`-- build/                FAKE build targets

Main Areas

• Specification describes the three unified ARC RDM profiles and decoration pages.
• Examples and schemas explains the current schema drafts and example status.
• Implementation explains the F# projects, SQL profile, runtime adapters, and build commands.
• Reference material lists upstream profiles and preserved implementation notes.
• Prior art notes summarizes the ARCtrl and query model background that shaped this repo.

Documentation

Documentation is built with fsdocs from the docs/ directory. Additional template content, including Mermaid support, lives in docs/_head.html.

Common commands:

dotnet fsdocs watch
.\build.cmd BuildDocs
.\build.cmd WatchDocs

Build And Test

The FAKE build project is invoked through the root wrapper scripts:

.\build.cmd BuildSolution
.\build.cmd RunTests

RunTests runs the configured shared suite, including the .NET, JavaScript, and Python paths.