Skip to content

Commit 2bbe452

Browse files
Prepare for Zenodo archival: add CITATION.cff, update README
Add machine-readable citation metadata with ORCID, ecosystem references, and keywords. Update README with features, architecture, citation section, and ecosystem links. Remove outdated project status checklist. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a5b4407 commit 2bbe452

3 files changed

Lines changed: 108 additions & 37 deletions

File tree

CITATION.cff

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
cff-version: 1.2.0
2+
title: "CAL Runtime: Cormorant Agentic Language Execution Engine"
3+
message: "If you use this software, please cite it using the metadata from this file."
4+
type: software
5+
authors:
6+
- family-names: Shatny
7+
given-names: Michael
8+
orcid: "https://orcid.org/0009-0006-2011-3258"
9+
repository-code: "https://github.com/semanticintent/cal-runtime"
10+
url: "https://cal.cormorantforaging.dev"
11+
abstract: >-
12+
CAL (Cormorant Agentic Language) Runtime is a deterministic execution engine
13+
for cascade analysis using the Cormorant Foraging methodology. It provides a
14+
complete TypeScript implementation including a Peggy-based parser, 6D cascade
15+
analyzer, DRIFT gap measurement, Fetch action decisions, and pluggable adapters
16+
for data sources and alert channels. CAL encodes the Cormorant Foraging Framework
17+
directly into language syntax — keywords like FORAGE, DRIFT, FETCH, CHIRP, PERCH,
18+
and WAKE map to framework layers, making methodology executable rather than
19+
descriptive. 192 passing tests validate the complete pipeline.
20+
keywords:
21+
- domain-specific-language
22+
- cormorant-agentic-language
23+
- cascade-analysis
24+
- cormorant-foraging
25+
- deterministic-execution
26+
- drift-measurement
27+
- fetch-decisions
28+
- 6d-methodology
29+
- intelligence-systems
30+
- biomimetic-framework
31+
license: MIT
32+
version: 1.0.0
33+
date-released: "2026-03-07"
34+
references:
35+
- type: software
36+
title: "Cormorant Foraging Framework: A Multi-Layered Architecture for Intelligence Systems"
37+
authors:
38+
- family-names: Shatny
39+
given-names: Michael
40+
doi: "10.5281/zenodo.18904952"
41+
url: "https://github.com/semanticintent/cormorant-foraging-framework"
42+
- type: software
43+
title: "6D Foraging Methodology: Strategic Dimensional Discovery"
44+
authors:
45+
- family-names: Shatny
46+
given-names: Michael
47+
doi: "10.5281/zenodo.18209946"
48+
url: "https://github.com/semanticintent/6d-foraging-methodology"
49+
- type: software
50+
title: "Semantic Intent SSOT"
51+
authors:
52+
- family-names: Shatny
53+
given-names: Michael
54+
doi: "10.5281/zenodo.17114972"
55+
url: "https://semanticintent.dev/papers/semantic-intent-ssot"

README.md

Lines changed: 53 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# 🪶 CAL Runtime
1+
# CAL Runtime
22

3-
**Cormorant Agentic Language (CAL) - Runtime Execution Engine**
3+
**Cormorant Agentic Language (CAL) Runtime Execution Engine**
44

5-
A deterministic execution engine for cascade analysis using the 6D Foraging Methodology.
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
7+
A deterministic execution engine for cascade analysis using the Cormorant Foraging methodology and 6D dimensional framework.
68

79
## What is CAL?
810

9-
CAL is a domain-specific language for finding hidden costs through cascade analysis. It turns methodology into executable code.
11+
CAL is a domain-specific language for finding hidden costs through cascade analysis. It turns methodology into executable code — keywords ARE the framework.
1012

1113
```cal
1214
-- Find high-urgency situations
@@ -27,11 +29,19 @@ THRESHOLD 1000
2729
ON EXECUTE CHIRP critical "Take action"
2830
```
2931

30-
## Installation
32+
## Features
3133

32-
```bash
33-
npm install @stratiqx/cal-runtime
34-
```
34+
- Methodology-native keywords (FORAGE, DRIFT, FETCH, CHIRP, PERCH, WAKE)
35+
- 6D dimension analysis (Customer, Employee, Revenue, Regulatory, Quality, Operational)
36+
- 3D Lens scoring (Sound x Space x Time)
37+
- DRIFT gap measurement (Methodology - Performance)
38+
- Fetch action decisions with multiplicative gating
39+
- Cascade pathway mapping with depth control
40+
- Financial impact calculation with cascade multipliers
41+
- Pluggable data adapters (JSON, memory, composite)
42+
- Pluggable alert adapters (console, file, webhook)
43+
- CLI tool for script execution
44+
- 192 passing tests across 8 test suites
3545

3646
## Quick Start
3747

@@ -55,32 +65,18 @@ const output = await execute(result.actionPlan, {
5565
console.log(output.results);
5666
```
5767

58-
## Project Status
59-
60-
**Phase 1: Validation & Stabilization** (Current)
68+
## Architecture
6169

62-
- [ ] Parser validation
63-
- [ ] Executor validation
64-
- [ ] End-to-end testing
65-
- [ ] Financial model documentation
66-
67-
See [CAL-IMPLEMENTATION-ANALYSIS.md](../cal/docs/CAL-IMPLEMENTATION-ANALYSIS.md) for full roadmap.
68-
69-
## Features
70-
71-
- ✅ Methodology-native keywords (FORAGE, DRIFT, FETCH)
72-
- ✅ 6D dimension analysis
73-
- ✅ 3D Lens scoring (Sound × Space × Time)
74-
- ✅ DRIFT gap measurement
75-
- ✅ Fetch action decisions
76-
- ✅ Cascade pathway mapping
77-
- ✅ Financial impact calculation
70+
```
71+
CAL Script → Parser (Peggy) → ActionPlan → Executor → Results
72+
73+
Data Adapters + Alert Adapters
74+
```
7875

7976
## Documentation
8077

81-
- [Language Reference](https://cal.cormorantforaging.dev)
78+
- [Language Specification](https://cal.cormorantforaging.dev)
8279
- [API Documentation](./docs/API.md)
83-
- [Testing Guide](./docs/TESTING.md)
8480
- [Architecture](./docs/ARCHITECTURE.md)
8581

8682
## Development
@@ -94,17 +90,37 @@ npm test
9490

9591
# Build
9692
npm run build
93+
```
94+
95+
## Ecosystem
96+
97+
CAL Runtime is the execution engine for the Cormorant Foraging Framework:
98+
99+
- [Cormorant Foraging Framework](https://cormorantforaging.dev) — Foundational methodology
100+
- [CAL Language Specification](https://cal.cormorantforaging.dev) — Language reference
101+
- [6D Foraging Methodology](https://6d.cormorantforaging.dev) — Dimensional analysis
102+
- [StratIQX](https://stratiqx.com) — Case studies and analysis platform
97103

98-
# Watch mode
99-
npm run dev
104+
## Citation
105+
106+
If you use CAL Runtime in your work, please cite:
107+
108+
```bibtex
109+
@misc{shatny2026cal,
110+
author = {Shatny, Michael},
111+
title = {CAL Runtime: Cormorant Agentic Language Execution Engine},
112+
year = {2026},
113+
publisher = {Zenodo},
114+
url = {https://github.com/semanticintent/cal-runtime},
115+
note = {ORCID: 0009-0006-2011-3258}
116+
}
100117
```
101118

102-
## License
119+
## Author
103120

104-
MIT © Michael Shatny
121+
**Michael Shatny**
122+
ORCID: [0009-0006-2011-3258](https://orcid.org/0009-0006-2011-3258)
105123

106-
## Links
124+
## License
107125

108-
- [6D Methodology](https://6d.cormorantforaging.dev)
109-
- [Cormorant Foraging](https://cormorantforaging.dev)
110-
- [StratIQX](https://stratiqx.com)
126+
MIT

bin/cal.js

100644100755
File mode changed.

0 commit comments

Comments
 (0)