34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# Fluksio
|
|
|
|
Fluksio is a node-based automation engine for experiments, buildings, and
|
|
homelabs. Connect small pieces of logic through typed messages, then let the
|
|
engine do the running.
|
|
|
|
- **Live flows** react to sensors, webhooks, and schedules.
|
|
- **Batch runs** take parameters, finish with a result, and keep metrics,
|
|
artifacts, and a history you can compare.
|
|
|
|
Both use the same nodes, editor, and API. Flows are versioned in git, so your
|
|
next bright idea comes with an undo trail.
|
|
|
|
## Start here
|
|
|
|
[Pick your starting point](getting-started/index.md):
|
|
|
|
- [Data science](getting-started/data-science.md): install with pip in your
|
|
research environment and run your first experiment.
|
|
- [Facility automation](getting-started/facility-automation.md): start one
|
|
Docker container and build your first live flow in the browser.
|
|
|
|
## Explore
|
|
|
|
| To… | Read |
|
|
|---|---|
|
|
| Understand flows, nodes, and messages | [Concepts](concepts/flows.md) |
|
|
| Edit flows and build dashboards | [The interface](interface/index.md) |
|
|
| Use Python, the CLI, or the API | [Code and the CLI](code/cli.md) |
|
|
| Look up nodes, payloads, and settings | [Reference](reference/node-types.md) |
|
|
|
|
Your instance keeps its data on its own disk. Connecting it to a
|
|
[portal](interface/portal.md) is optional; local flows and runs work offline.
|