ekx Docs
Open appSign in

ekx documentation

Complete guide to building, analyzing, and managing electrical single-line diagrams in ekx.

Quick start

New to ekx?

  1. Getting started - Sign up and first project
  2. Build a single-line diagram - Create your first SLD
  3. Running power flow - Analyze your system

Common tasks:

Learning paths

Choose your path based on your role and goals:

Path 1: New electrical engineer

Learn to build and analyze electrical systems:

  1. Fundamentals (understand before building)
  1. Building diagrams (create your first SLD)
  1. Analysis (verify your design)
  1. NEC sizing (ensure code compliance)

Path 2: Experienced engineer

Jump to advanced features and analysis:

  1. Power flow analysis
  1. Short-circuit analysis
  1. Harmonic analysis
  1. Arc flash analysis
  1. NEC compliance
  1. Advanced features

Path 3: Team administrator

Set up the organization:

  1. Organization setup
  1. Component defaults
  1. Custom reference tables
  1. Project management

Path 4: Device Catalog workflows

Inspect reusable protection-device data and import it through an EKX-compatible agent:

  1. Add a device to the catalogue - Add or correct sourced catalogue records through your agent or EKX support
  2. Import manufacturer curves - Add reviewed PDF curve data through the same agent workflow
  3. Protection devices - Assign catalog data in a project
  4. Plans and pricing - AI credit allocations per plan

Path 5: API automation

Connect scripts and user-controlled agents to project data and engineering workflows:

  1. Connect to the API - Create a key and authenticate requests
  2. Import a single-line diagram with an agent - Turn an existing drawing into an editable project
  3. Project data - Read, create, replace, and patch projects
  4. Studies and sizing - Run studies and apply reviewed sizing proposals
  5. Cable library - Add your own cable series with their resistance and reactance

Documentation structure

Fundamentals

Core electrical and software concepts:

Projects

Creating and managing projects:

SLD editor

Building single-line diagrams:

Getting started:

Canvas operations:

Component guides:

Advanced features:

Analysis

Power flow and short-circuit calculations:

Power flow:

Short-circuit:

Arc flash:

NEC sizing

Conductor and protection device sizing:

Component defaults

Hierarchical default values:

Reference tables

NEC tables and customization:

Device Catalog

Reusable device data and manufacturer curves:

Billing

Plans and subscription management:

Settings

User and organization configuration:

API

Programmatic project and engineering workflows:

Collaboration

Working with teams:

Reference

Complete technical documentation:

What you can do in ekx

Model electrical systems:

  • Buses, transformers, cables, generators
  • Motors, loads, protection devices
  • Utility connections and distribution

Analyze power systems:

  • Power flow (voltages, currents, losses)
  • Short-circuit (fault currents, interrupting capacity)
  • Voltage drop and loading

Size per NEC 2026:

  • Conductor ampacity with derating
  • Overcurrent protection devices
  • Motor branch circuits
  • Parallel conductor runs

Work as a team:

  • Organization-wide component defaults
  • Custom reference tables
  • Project templates

Automate project work:

  • Read project models and saved engineering evidence
  • Create, replace, and patch single-line diagrams
  • Run power flow, short-circuit, and arc flash studies
  • Preview and apply sizing proposals

Getting help

Documentation:

  • Search this documentation
  • Follow learning paths above
  • Check troubleshooting guides

In-app support:

  • Validation dialog before calculations
  • Feedback button (bug icon, bottom right of the editor) to send a report with diagnostics

Common issues:

Documentation conventions

Step-by-step instructions:

  • Numbered steps for procedures
  • One action per step
  • Expected results included

UI elements:

  • Bold for buttons and menus
  • Code format for values and field names
  • > Arrows for navigation paths

Tables:

  • Quick reference information
  • Property specifications
  • Comparison matrices

Notes and warnings:

  • Additional context
  • Critical safety information
  • Best practices

Docs contribution

Found an error or want to suggest improvements?

  • Documentation follows AGENTS.md style guide)
  • Audience: Electrical engineers using the app
  • Voice: Direct, task-oriented, second person
  • Report issues at project repository

Last updated: 2026-08-30

On this page

Quick startLearning pathsPath 1: New electrical engineerPath 2: Experienced engineerPath 3: Team administratorPath 4: Device Catalog workflowsPath 5: API automationDocumentation structureFundamentalsProjectsSLD editorAnalysisNEC sizingComponent defaultsReference tablesDevice CatalogBillingSettingsAPICollaborationReferenceWhat you can do in ekxGetting helpDocumentation conventionsDocs contribution