DocsGetting Started

Getting Started

Your first experience with CyxWiz Engine - launching the application and exploring the interface.

Launching the Engine

Start the application:
- Windows: Run cyxwiz-engine.exe
- macOS/Linux: Run ./cyxwiz-engine
Wait for initialization: Python interpreter and GPU backends are loaded

Understanding the Interface

+------------------------------------------------------------------+
|  File  Edit  View  Nodes  Train  Dataset  Script  Plots  Deploy  |
+------------------------------------------------------------------+
|                    |                            |                 |
|   Asset Browser    |     Central Workspace      |   Properties    |
|                    |     (Node Editor/Script)   |                 |
|   [Project Files]  |                            |   [Selected     |
|   - Scripts/       |                            |    Item Props]  |
|   - Models/        |                            |                 |
|   - Datasets/      |                            |                 |
+--------------------+----------------------------+-----------------+
|                                                                   |
|   Console / Script Editor / Training Dashboard                    |
|                                                                   |
+------------------------------------------------------------------+

Menu Bar

Access all features and commands.

Asset Browser

Navigate project files (scripts, models, datasets).

Central Workspace

Node Editor or Script Editor view.

Properties

Edit selected item properties.

Console

Python REPL and output logs.

Creating Your First Project

Go to File → New Project (or Ctrl+Shift+N)
Choose a location and name for your project
Click Create

my_project/
├── scripts/        # Python and .cyx scripts
├── models/         # Saved models
├── datasets/       # Data files
└── project.cyxproj # Project configuration

Quick Tour of Menus

Menu	Key Features
File	New/Open Project, New Script, Save
View	Node Editor, Script Editor, Console, Properties
Nodes	Add Node, Validate Graph, Generate Code
Train	Start/Stop Training, Configure
Tools	70+ data science and ML tools

Essential Shortcuts

Action	Shortcut
New Project	Ctrl+Shift+N
Open Project	Ctrl+O
Save	Ctrl+S
Node Editor	Ctrl+1
Script Editor	Ctrl+2
Console	Ctrl+`
Command Palette	Ctrl+Shift+P

Checking GPU Status

Look at the bottom status bar for GPU info, or verify in Python:

>>> import pycyxwiz as cyx
>>> print(cyx.cuda_available())
True

Troubleshooting

Engine Won't Start

Check OpenGL 3.3+ support and verify dependencies are installed.

No GPU Detected

Install CUDA Toolkit (NVIDIA) or OpenCL drivers (AMD/Intel).

Python Errors

Ensure Python environment is configured correctly.