Quick Start

English | 简体中文

Applies to DecisioWorks v1.4.0

Quick Start

This page helps you complete one verifiable first run. The README, dependency files, and license instructions shipped with your edition take precedence over the general examples below.

1. Confirm the edition and environment

The Commercial Edition supports Linux x86_64 with Python 3.11 or 3.12. Use the Research Edition artifact built for your platform and Python version. Create an isolated virtual environment for each distribution to prevent dependency drift.

Run the following commands from the distribution root. Confirm that it contains:

• the distribution README and dependency file;
• web_cockpit/;
• DataSets or the data directory specified by the distribution;
• a valid license.rkey when using the Commercial Edition.

2. Install dependencies

Install from the dependency file included in the current distribution. Do not infer requirements from another release. If dependency conflicts appear, reproduce the issue in a clean isolated environment first.

3. Start the Web cockpit

python3 web_cockpit/demo_console_api.py --host 127.0.0.1 --port 8765

Open http://127.0.0.1:8765/. If the port is occupied, choose another available port and use the same value in the browser URL.

4. Complete the first run

1. Check license status, edition, and authorization level; for the Research Edition, check the available capability scope.
2. Open Scenario Lab and select a dataset marked SolverReady.
3. Inspect input tables, major relationships, solving time, and thread settings.
4. Run the baseline and wait for a completed or explicit failure state.
5. Inspect planning results, aggregate metrics, object-level analysis, and objective-material audit.
6. If the page offers editable objective weights, change one within its permitted range, rerun, and compare. If the scenario uses fixed objectives, complete the baseline review first.

Available controls depend on the scenario, capability and license. Use the controls and limits actually shown for solving time, threads and other run parameters. Change business rules, work centers or resource calendars in the relevant data or orchestration recipe, then reload through the dataset's supported loading path before running again. Scenario Lab's data tables are not a general-purpose editor.

A page opening successfully is not sufficient. A successful first run means that data is visible, the run reaches a terminal state, results are available, and the observed differences can be explained.

5. Troubleshooting priorities

Symptom	Check first
Page does not open	Working directory, port availability, server log
Dataset cannot be selected	Dataset path, catalog entry, readiness status
Commercial Edition reports no license	license.rkey location, expiry, device match, authorization level
Parameter rejected	Displayed authorization limits, solving time, thread count
Run fails or has no feasible solution	Relationship validation, conflicting constraints, time limit, diagnostics
Result table remains empty	Terminal run state, selected dataset, result API response

Do not interpret weighted objective values as physical business quantities. Read load, time, shortage, and delivery deviation with their displayed units and object granularity.

Continue with the End-to-End Scenario Walkthrough and Security and Support.