A JavaFX desktop workbench for authoring semantic models, managing scientific resources, running k.Actors behaviors, and exploring observations in k.LAB digital twins.
The IDE is the desktop client for the k.LAB 1.0 service stack. k.LAB turns a request for knowledge expressed as meaning in context into a computational plan and an observation, retaining its semantics and provenance. Start with the k.LAB introduction for the platform's purpose and architecture.
Download the prototype · User guide · k.LAB documentation · Report an issue
Important
This is a pre-alpha prototype under active development. Available actions depend on identity, permissions, connected services, and installed adapters. See the current limitations before planning a deployment.
- Features
- Getting started
- IDE documentation
- Learn k.LAB
- Build and run from source
- Repository layout
- Project and support
- Author knowledge: browse service-hosted workspaces and projects; edit namespaces, ontologies, observation strategies, and behaviors with Monaco and language-service support; save and inspect validation results and version-control state.
- Manage resources: create and import adapter-backed resources, edit and validate descriptions, save versions or temporary data, publish local resources, and administer access where permitted.
- Run behaviors: create local k.Actors files or check out managed project behaviors into persistent local mirrors; compile, run, debug, and submit them back to their projects.
- Observe and inspect: submit workspace assets to a digital twin, preview the receiving context, follow activities and observations, inspect knowledge graphs, and explore geometry and time-dependent quality maps when runtime exports are available.
- Review work: browse asset workflows and use source review and side-to-side views. New workflows and specialized forms require a configured workflow provider.
- Arrange the workbench: use dockable editor tabs, inspection history, service dashboards, notifications, and local service-distribution controls.
The IDE user guide describes these workflows and their current boundaries.
- Download the prototype and follow the installation instructions for your platform, or build from source.
- Open the user profile to check your identity and the service rail to check available services. Workspace and resource authoring use a Resources service. Observation requests use a Runtime with supporting Reasoner, Resources, and Resolver services.
- If you need a local stack, use the distribution-management and power controls in the IDE. Remote services may be usable independently, subject to permissions.
- Open Workspaces, Resources, Applications, or Digital Twins for your task.
For service setup and backend development, use the klab-services README. Building the desktop client alone does not install a configured service stack or grant access to knowledge and data.
| Resource | Purpose |
|---|---|
| User guide | Navigation, authoring, resources, behaviors, digital twins, and current limitations |
| Architecture | Application shell, controllers, editors, and service integration; some subsystem descriptions predate newer features |
| Workflow integration | Workflow providers, stage editors, navigation, and authorization |
| Conveyor build guide | Packaging background and platform targets |
| Maven configuration, Conveyor configuration, CI pipeline | Current build, packaging, signing, and deployment configuration |
The following guides live in the companion klab-services repository. Links target its develop
branch, matching the evolving 1.0 codebase.
| Topic | Resources |
|---|---|
| Platform and architecture | k.LAB overview, service architecture |
| Semantic modeling | Modeling guide, observable expressions |
| Authoring languages | Worldview ontologies, k.IM, k.Actors |
| Observation and execution | Observation strategies, resolution, scopes |
| Data and traceability | Resources, storage, provenance |
| Extensions and collaboration | Components and adapters, workflow contracts, behavior testing |
Some platform guides include proposals and implementation ledgers; their status notes distinguish available behavior from planned extensions.
Use JDK 21 and Maven (or the included Maven wrapper). The build depends on k.LAB SNAPSHOT artifacts and companion libraries, including the modeler, Monaco editor, and JavaFX graph library. These must be available from the configured repositories or installed in your local Maven cache.
On Windows, from the repository root:
.\mvnw.cmd clean test
.\mvnw.cmd javafx:run@runOn Linux or macOS:
./mvnw clean test
./mvnw javafx:run@runConveyor packaging is enabled through -Pconveyor. Consult the current configuration and CI
pipeline linked above for required environment variables, signing, assets, and output targets;
the older packaging guide is background rather than an exact deployment recipe.
src/main/java/org/integratedmodelling/klab/ide: application, service coordination, editors, inspection cards, and reusable JavaFX controls.src/main/resources: FXML, styles, icons, and package resources.src/test/java: automated regression and contract tests.docs: user and developer documentation.
Use IDE issues for client bugs and feature requests, and service issues for backend problems. Include the build, operating system, relevant service versions, and steps to reproduce.
Project information: Integrated Modelling. The IDE packaging declares AGPL-3.0-or-later; the companion service repository includes the AGPL license text.