voleum/gr-base
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add website with docs

Browse source
This commit is contained in:
EatThePooh 2025-08-25 18:17:01 +07:00
parent 870c20e745
commit fcf1979a1d
12 changed files with 541 additions and 314 deletions
Download patch file Download diff file Expand all files Collapse all files

167
README.org
View file

@ -1,58 +1,12 @@
:PROPERTIES:
:ID: 55a85682-80d7-41fe-ab55-d3afe9abbc38
:END:
#+OPTIONS: toc:nil
#+BEGIN_EXPORT html
<style>
body {
font-family: 'Courier New', Courier, monospace;
background-color: ivory;
line-height: 1.5;
padding-right: 1em;
}
h2 {
margin-top: 1.8rem;
padding-left: 0.5rem;
border-left: 4px solid #3498db;
}
table {
width: 100%;
}
#content {
max-width: 48em;
}
.outline-2 div {
padding-left: 1em;
}
a:link {
color: #2E5EAA;
text-decoration: none;
}
a:visited {
color: #663399;
}
a:hover {
color: #1a4480;
text-decoration: underline;
}
</style>
#+END_EXPORT
#+title: Grimu-R
Grimu-R is an *open ecosystem* and a framework for mixed visual-textual *dataflow* scripting.
*Grimu-R* is an open ecosystem and a framework for mixed visual-textual dataflow scripting.
It consists primarily of the following components:
- Execution model allowing computations to be expressed as *reactive graphs*
- *Polyglot scripting* runtime environment
- Interactive web-based *visual-textual* editor
- *Polyglot scripting* runtime environment
- Execution model allowing computations to be expressed as *reactive graphs*
#+TOC: headlines 2
* Table of Contents :TOC_2_gh:noexport:
- [[#inspiration][Inspiration]]
- [[#goals][Goals]]
- [[#immediate-feedback-and-composability][Immediate feedback and composability]]
- [[#embeddable-build-targets][Embeddable build targets]]
@ -66,8 +20,8 @@ It consists primarily of the following components:
- [[#positioning][Positioning]]
- [[#nomenclature][Nomenclature]]
- [[#weave][Weave]]
- [[#ornament][Ornament]]
- [[#spell][Spell]]
- [[#braid][Braid]]
- [[#sigil][Sigil]]
- [[#scroll][Scroll]]
- [[#inscription][Inscription]]
- [[#how-it-works][How it works]]
@ -75,7 +29,6 @@ It consists primarily of the following components:
- [[#workflow][Workflow]]
- [[#cross-language-connections][Cross-language connections]]
- [[#execution-environment][Execution environment]]
- [[#features][Features]]
- [[#faq][FAQ]]
- [[#is-this-a-yet-another-web-framework][Is this a yet another web framework?]]
- [[#how-does-malleability-work-in-client-server-applications][How does malleability work in client-server applications?]]
@ -83,13 +36,8 @@ It consists primarily of the following components:
- [[#how-do-i-test-my-weave][How do I test my weave?]]
- [[#can-i-integrate-ai-models][Can I integrate AI models?]]
- [[#licensing][Licensing]]
- [[#how-it-works-1][How it works]]
- [[#compliance-guide][Compliance guide]]
* Inspiration
- [[https://github.com/enso-org/enso][Enso]]
- [[https://unit.software][Unit]]
- [[https://jupyter.org/][Jupyter Notebooks]]
- [[https://observablehq.com/][Observable]]
* Goals
** Immediate feedback and composability
@ -101,7 +49,7 @@ experiment and reuse previous work.
An interactive visual editor allows one to prototype, debug and run one-off jobs comfortably.
But the work can always be distilled into an executable artifact:
a CLI tool, an RPC server, or a web application, to be distributed as such or integrated into larger workflows.
a CLI tool, an RPC server, or a web application, to be distributed as such or integrated into larger flows.
** Hassle-free reproducible builds
@ -136,19 +84,18 @@ Get started without implementing your own components.
Low code to high code.
* Non-goals
Some things Grimu-R itself will not take care of, delegating them to the surrounding environment:
Some things Grimu-R itself will not take care of, delegating them to the surrounding environment or just omitting:
- Resumable/durable execution
- Distributed deployment orchestration
- Collaborative editing
- Real-time collaborative editing
- Authentication and access control
- Telemetry
* Use cases
- Rapid prototyping of data processing pipelines
- Self-hosted workflow automation
- Dashboards with custom logic
- Internal tooling and automation scripts
- Hacker-friendly, highly customizable applications
- Rapid prototyping of *data processing* pipelines
- *Self-hosted* workflow automation
- *Dashboards* with custom logic
- *Internal tooling* and automation scripts
- Hacker-friendly, highly *customizable* applications
* Positioning
Grimu-R aims to take the best without the worst from:
@ -168,47 +115,49 @@ A Grimu-R project's weave is what changes when someone is working on it ("weavin
It's a persistent, Git-friendly representation of the dataflow graph and its graphic layout.
** Ornament
** Braid
Weaves are composed of ornaments, which serve the dual purpose of reusable modules and entry points.
Weaves are composed of braids, which serve the dual purpose of reusable modules and entry points.
An ornament would correspond to an RPC method or a CLI subcommand.
An braid could correspond to an RPC method or a CLI subcommand in a build.
Ornaments can be nested within other ornaments, appearing as single nodes that encapsulate their internal graphs.
Braids can be nested within other braids, appearing as single nodes that encapsulate their internal graphs.
** Spell
** Sigil
Spells are the basic building blocks for ornaments.
Sigils are the basic building blocks for braids.
A spell is just a normal computer program that acts as:
A sigil is just a normal computer program that acts as:
- data source (e. g. a static CSV sheet)
- data sink (e. g. a POST endpoint)
- data transformer (e. g. grep)
Each spell is based on a scroll and can contain a dynamic script ("inscription") stored in the weave.
Each sigil is based on a scroll and can contain a dynamic script ("inscription") stored in the weave.
** Scroll
Scrolls define a default configuration for spells, as well as the runtime environment to run a spell in.
Scrolls define a default configuration for sigils, as well as the runtime environment to run a sigil in.
They are developed outside of Grimu-R using standard development tooling.
They are developed outside of Grimu-R using standard development tooling and integrated with Nix.
** Inscription
Spells based on interpreter scrolls (like Bash, Node.js) can have their inscriptions edited
Sigils based on interpreter scrolls (like Bash, Node.js) can have their inscriptions edited
directly in the visual editor, enabling live code changes without rebuilding the development environment.
There can be other kinds of inscriptions: templates, configurations, parameters, etc.
* How it works
** Development environment
Grimu-R projects being Nix flakes, the development tooling ("loom") is provisioned in a Nix shell.
It gives you the visual editor, the companion CLI tool and the execution context for spells.
It gives you the visual editor, the companion CLI tool and the execution context for sigils.
** Workflow
- The visual editor is served by a development or application server.
- Changes and execution requests for server-side spells are sent over a bidirectional WebSocket connection.
- Changes and execution requests for natively executed sigils are sent over a bidirectional WebSocket connection.
- User modifications are stored locally in the browser's storage, exportable as a file.
- Weaves are tracked by usual VCS tools.
@ -220,23 +169,13 @@ Think Unix pipes but with structured data formats like JSON lines instead of pla
Purpose-specific scrolls used in a weave have their requirements defined in Nix terms.
For example, if several scrolls need Deno, they can all refer to the same deno Nix package defined in the flake and declare their Deno dependencies normally.
For example, if several scrolls need Deno, they can all refer to the same deno Nix package defined in the flake's nixpkgs overlay and declare their Deno dependencies normally in deno.json.
A single copy of Deno runtime and a shared Deno cache would be bundled in an edition.
A single copy of Deno runtime and a shared Deno cache would be bundled in a build.
However, the general-purpose Deno scroll executing arbitrary TypeScript inscriptions
would have Deno fetch dependencies during runtime.
* Features
| | On the roadmap | Ideas |
|--------------------------+--------------------------------+--------------------|
| Editions (build targets) | Self-sufficient CLI executable | Mobile application |
| | CLI client + RPC server | React component |
| | Web application | |
| | | |
| Scripting languages | TypeScript | DuckDB SQL |
| | Bash | Python |
| | Haskell | R |
* FAQ
** Is this a yet another web framework?
@ -249,8 +188,8 @@ Or you could use any framework you like with the dataflow stuff being incidental
** How does malleability work in client-server applications?
Unlike standalone editions executing entirely on the end user's machine,
client-server editions split the weave between runtime components.
Unlike standalone builds executing entirely on the end user's machine,
client-server builds split the weave between runtime components.
Only the client-side part of the weave can be inspected and edited by
the end user.
@ -260,7 +199,7 @@ the end user.
To some extent, yes.
While Grimu-R is built on top of Nix and wouldn't make a lot of sense otherwise,
you always have the option to access out-of-store files from your spells' inscriptions,
you always have the option to access out-of-store files from your sigils,
at the cost of reproducibility.
So you could use e. g. runtime JS imports or call some executable on PATH from a shell script.
@ -268,27 +207,27 @@ So you could use e. g. runtime JS imports or call some executable on PATH from a
** How do I test my weave?
If you do it manually: right in the visual editor.
Add spells with a constant output as test data sources and stitch them to the spells you want to test.
Add sigils with a constant output as test data sources and connect them to the sigils you want to test.
If you need automation: build an edition and call the ornaments programmatically.
If you already have test data stored in the weave, you can extract it by the spell's id using loom CLI or library.
If you need automation: call the braids programmatically.
If you already have test data stored in the weave, you can extract it by the sigil's id using loom CLI or library.
** Can I integrate AI models?
There are three integration scenarios which would make sense:
1. AI spells in the weave:
1. AI sigils in the weave:
Spells calling inference APIs, equipped with MCP spells and
template spells for prompt composition
Sigils calling inference APIs, equipped with MCP sigils and
template sigils for prompt composition
2. AI weaving copilot:
Loom providing AI tools to edit the weave
3. MCP server editions:
3. MCP server builds:
Ornaments exposed as tools for external AI systems
Braids exposed as tools for external AI systems
#1 is easy to do even with no out-of-the-box support.
@ -296,7 +235,7 @@ There are three integration scenarios which would make sense:
* Licensing
The Grimu-R platform components, including Loom development utilities and
the execution engine, are licensed under AGPL v3.
the weave executor builders, are licensed under AGPL v3.
Base scrolls and other non-platform code are licensed under MIT.
@ -315,9 +254,19 @@ original license terms specified above.
Alternative contribution arrangements may be available upon request.
** How it works
If you fork the platform and build a product on top of its code,
the fork MUST be licensed under AGPL v3 (or a more restrictive copyleft license),
even if it's a cloud product.
** Compliance guide
Your options for licensing your work are restricted in the following scenarios:
All other code can be used without restrictions.
1. You fork Loom or weave executor builders and distribute your fork.
2. You build a product extending the platform's or its fork's functionality
while incorporating their code.
3. Your weave or scrolls make use of third-party copyleft-licensed software.
This is independent of Grimu-R platform's licensing.
Note that AGPL terms apply even for SaaS solutions.
Loom being AGPL does not affect the licensing of weaves you develop using it.
Weave executors being AGPL means that your application using them has
to provide AGPL license notice and link to their source code repository;
your application's code, however, needs not be provided.