Skip to content

docs: update ecosystem.md with all 9 packages #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rororowyourboat merged 1 commit into from
Mar 4, 2026
Merged

docs: update ecosystem.md with all 9 packages #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 33 additions & 19 deletions docs/framework/ecosystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,53 @@ The GDS ecosystem is a family of composable packages for specifying, visualizing

## Packages

| Package | Description | Docs | PyPI |
|---|---|---|---|
| **gds-framework** | Foundation — typed compositional specifications | [Docs](https://blockscience.github.io/gds-framework) | [PyPI](https://pypi.org/project/gds-framework/) |
| **gds-viz** | Mermaid diagram renderers for GDS specifications | [Docs](https://blockscience.github.io/gds-viz) | [PyPI](https://pypi.org/project/gds-viz/) |
| **gds-games** | Typed DSL for compositional game theory | [Docs](https://blockscience.github.io/gds-games) | [PyPI](https://pypi.org/project/gds-games/) |
| **gds-examples** | Six tutorial models demonstrating every framework feature | [Docs](https://blockscience.github.io/gds-examples) | [PyPI](https://pypi.org/project/gds-examples/) |
| Package | Import | Description |
|---|---|---|
| **gds-framework** | `gds` | Core engine — blocks, composition algebra, compiler, verification |
| **gds-viz** | `gds_viz` | Mermaid diagram renderers for GDS specifications |
| **gds-stockflow** | `stockflow` | Declarative stock-flow DSL over GDS semantics |
| **gds-control** | `gds_control` | State-space control DSL over GDS semantics |
| **gds-games** | `ogs` | Typed DSL for compositional game theory (Open Games) |
| **gds-software** | `gds_software` | Software architecture DSL (DFD, state machine, C4, ERD, etc.) |
| **gds-business** | `gds_business` | Business dynamics DSL (CLD, supply chain, value stream map) |
| **gds-sim** | `gds_sim` | Simulation engine (standalone, Pydantic-only) |
| **gds-examples** | — | Tutorial models demonstrating framework features |

## Dependency Graph

```mermaid
graph TD
F[gds-framework] --> V[gds-viz]
F --> G[gds-games]
F --> SF[gds-stockflow]
F --> C[gds-control]
F --> SW[gds-software]
F --> B[gds-business]
F --> E[gds-examples]
V --> E
G --> E
SF --> E
C --> E
SW --> E
B --> E
SIM[gds-sim]
```

## Architecture

```
gds-framework (foundation)
│
│ Domain-neutral composition algebra, typed spaces,
│ state model, verification engine, flat IR compiler.
│
├── gds-viz (visualization)
│ └── 6 Mermaid diagram views of GDS specifications
│
├── gds-games (game theory DSL)
│ └── Open games, pattern composition, verification, reports, CLI
│
└── gds-examples (tutorials)
└── 6 complete domain models with tests and visualizations
gds-framework ← core engine (no GDS dependencies)
↑
gds-viz ← visualization (depends on gds-framework)
gds-games ← game theory DSL (depends on gds-framework)
gds-stockflow ← stock-flow DSL (depends on gds-framework)
gds-control ← control systems DSL (depends on gds-framework)
gds-software ← software architecture DSL (depends on gds-framework)
gds-business ← business dynamics DSL (depends on gds-framework)
↑
gds-examples ← tutorials (depends on gds-framework + gds-viz + all DSLs)

gds-sim ← simulation engine (standalone — no gds-framework dep, only pydantic)
```

## Links
Expand Down