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:

• Create a project
• Add components
• Connect components
• Run calculations
• Size conductors and protection

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)

• Electrical concepts
• Understanding components
• Connection rules

1. Building diagrams (create your first SLD)

• Create a project
• Build a single-line diagram
• Component guides - Start with buses
• Connections

1. Analysis (verify your design)

• Understanding power flow
• Running power flow
• Interpreting results

1. NEC sizing (ensure code compliance)

• Sizing overview
• Cable sizing
• OCPD sizing

Path 2: Experienced engineer

Jump to advanced features and analysis:

1. Power flow analysis

• Understanding power flow - Theory and methods
• Running power flow - Execution
• Interpreting results - Voltage, loading, violations
• Troubleshooting convergence - Fix failures

1. Short-circuit analysis

• Understanding short-circuit - Fault current
• Fault types - 3ph, 2ph, 1ph
• Running analysis - Equipment verification

1. NEC compliance

• Cable sizing - Ampacity, derating, paralleling
• OCPD sizing - Motors, standard sizes
• Warnings and errors - Resolve issues

1. Advanced features

• Scenarios - What-if analysis
• Exports - PDF, DXF, and report export
• Auto-connect - Proximity connections
• Validation warnings - Pre-calculation checks
• Debug panel - Troubleshooting

Path 3: Team administrator

Set up teams and manage organization:

1. Organization setup

• Organizations - Team structure
• Organization settings - Configure org
• Managing members - Roles and access

1. Component defaults

• Understanding defaults - Hierarchy system
• Setting defaults - Organization-wide values
• Defaults tutorial - Practical walkthrough

1. Custom reference tables

• Reference tables overview - NEC tables
• Customizing tables - Organization overrides

1. Project management

• Manage projects - Organization projects
• Project members and permissions - Access control

Path 4: AI-assisted workflows

Use AI to accelerate diagram creation:

1. Using AI chat - Natural language commands
2. AI commands - Add, modify, connect, import from PDF
3. Plans and pricing - AI credit allocations per plan
4. Build a single-line diagram - Manual and AI hybrid workflow

Documentation structure

Fundamentals

Core electrical and software concepts:

• Electrical concepts - Power systems, voltages, three-phase
• Understanding components - Categories and roles
• Connection rules - Valid electrical connections
• Voltage propagation - Voltage zones and automatic consistency

Projects

Creating and managing projects:

• Create a project
• Manage projects - Edit, duplicate, archive, delete
• Project members and permissions - Collaboration

SLD editor

Building single-line diagrams:

Getting started:

• Build a single-line diagram
• Connections - Manual and auto-connect

Canvas operations:

• Keyboard shortcuts
• Navigation and zoom
• Selection techniques
• Context menu - Right-click operations, Copy Data, Duplicate

Component guides:

• Buses - Dynamic connection points
• Cables - Conductors and impedances
• Transformers - Voltage conversion
• Generators - On-site power sources
• Loads and motors - Power consumption
• Protection devices - Breakers and fuses
• Utility feeds - Grid connections

Advanced features:

• Auto-connect - Proximity-based connections
• Scenarios - What-if analysis and design comparison
• Exports - PDF, DXF, and report export
• Validation warnings - Pre-calculation checks
• Debug panel - Data inspection

Analysis

Power flow and short-circuit calculations:

Power flow:

• Understanding power flow - Theory
• Running power flow - Execution steps
• Interpreting results - Voltages, loading, violations
• Troubleshooting convergence - Fix failures

Short-circuit:

• Understanding short-circuit - Fault currents
• Fault types - Three-phase, phase-to-phase, single-phase
• Running analysis - Equipment verification

NEC sizing

Conductor and protection device sizing:

• Sizing overview - NEC 2026 engine
• Auto-sizing - Automatic cascade sizing and toggle controls
• Cable sizing - Ampacity, derating, paralleling
• Auto-parallel sizing - Automatic parallel conductor configuration
• OCPD sizing - Breakers, fuses, motor protection
• Warnings and errors - Troubleshooting sizing issues

Component defaults

Hierarchical default values:

• Understanding defaults - System/org/project/user hierarchy
• Setting defaults - Save component values
• Defaults tutorial - Step-by-step walkthrough with examples

Reference tables

NEC tables and customization:

• Reference tables overview - NEC 2026 default tables
• Customizing tables - Organization and user overrides

AI assistant

Natural language diagram building:

• Using AI chat - Commands and capabilities
• AI commands - Add, modify, delete, connect components

Billing

Plans and subscription management:

• Plans and pricing - Feature comparison, AI credits, limits

Settings

User and organization configuration:

• User settings - Profile, preferences, defaults
• Organization settings - Team management, billing

Collaboration

Working with teams:

• Organizations - Team structure and roles

Reference

Complete technical documentation:

• Component properties - All properties, units, ranges
• Electrical standards - NEC, IEEE, IEC
• Glossary - Electrical and software terms

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

Collaborate with teams:

• Share projects within organization
• Assign roles (owner, editor, viewer)
• Organization-wide component defaults
• Custom reference tables

AI-assisted workflows:

• Natural language commands
• Automatic component creation
• Connection suggestions
• Diagram modifications
• Import SLD from PDF or image
• Parse device settings from datasheets

Getting help

Documentation:

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

In-app support:

• Debug panel for data inspection
• Validation warnings before calculations
• Export debug files for issues

Common issues:

• Troubleshooting convergence - Power flow failures
• Sizing warnings and errors - NEC sizing issues
• Validation warnings - Connection problems

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-02-09 | Version: 1.1.0 | Coverage: ~98% of features