Features
Documentation Tutorials FAQ About
Install

Commands Reference

Odatix provides two command-line tools:

  • odatix — initialize workspaces, generate configurations, run jobs, monitor sessions and export results.
  • odatix-explorer — visualize results in a web UI.

Table of Contents

Getting help

Terminal
odatix -h
odatix <command> -h
odatix-explorer -h

Global options

Option Description
-h, --help Show global and subcommand help.
-v, --version Print the Odatix version and exit.
--init Interactive initialization of the current directory.

Command map

Category Commands Purpose
Initialization odatix init Initialize workspace files (non-interactive).
Configuration odatix config Read and change the configuration of the workspace.
Generation odatix generate, odatix replace Generate parameter files and replace delimited sections.
Execution odatix fmax, odatix synth, odatix pnr, odatix analyze, odatix sim, odatix workflow Enqueue and run synthesis, place & route, RTL analysis, simulation and workflow jobs.
Daemon sessions odatix ls, odatix monitor, odatix stop Inspect, attach and stop daemon sessions.
Export odatix results, odatix res_synth, odatix res_benchmark, odatix res_workflow, odatix res_simulation, odatix res_derived Export benchmark, synthesis, workflow and simulation results, and apply derived metrics.
Maintenance odatix clean Remove generated files from a clean profile.
Exploration odatix-explorer, odatix-gui Interactive visualization of results, and the full graphical interface.

Common runtime options

fmax, synth, pnr, sim and workflow share most runtime flags:

Option Meaning
-o, --overwrite Overwrite existing results.
-y, --noask Do not ask for confirmation before launch.
-d, --detach Enqueue jobs and return immediately (no monitor).
-S, --session Session name/selector for enqueue/attach/stop.
-j, --jobs Maximum parallel jobs (auto = available CPUs − 1).
-E, --exit Exit the monitor when all jobs complete.
--logsize Per-job log history size in the monitor.
-k, --keep Keep timestamped run directories (fmax, synth, sim and workflow).
-D, --debug Verbose debug diagnostics.
-c, --config Alternate workspace settings file (default odatix.yml).
-Q, --nobanner Disable the Odatix banner.

Job-specific options

Command Additional options
odatix fmax -t/--tool, -f/--flow, -u/--until, --rerun-from, --from, --to, --continue-on-error, -T/--trust, -e/--noexport
odatix synth -t/--tool, -f/--flow, -u/--until, --rerun-from, --from, --to, --step, --at (repeatable), -T/--trust, -e/--noexport
odatix analyze -t/--tool (repeatable), -f/--flow (repeatable), -T/--trust, -e/--noexport
odatix pnr -t/--tool, -f/--flow, -u/--until, --rerun-from, --from-type, --from-tool, --from-flow, -i/--input, -w/--work, -T/--trust, -e/--noexport
odatix sim -a/--archpath, -s/--simpath, -w/--work
odatix workflow -p/--workflowpath, -w/--work, -r/--resume, -e/--noexport
Note

--continue-on-error used to be called -f/--force. The long form --force is still accepted, but -f now selects a flow.

Note

odatix synth used to be called odatix freq. freq (and synthesis) are still accepted as aliases.

Selecting a flow

A flow is a way of running an eda tool: a different script, different options, sometimes a different binary. Vivado ships a timing oriented flow and a power oriented one (automatic clock gating); Design Compiler ships a dc_shell flow and a dcnxt_shell one.

The flows of a tool are declared in the flows section of its tool.yml. When -f/--flow is not given, the tool’s default flow is used (its default_flow key).

Terminal
odatix synth --tool vivado                     # default flow ("standard")
odatix synth --tool vivado --flow power_opt    # clock gating + power optimization
odatix fmax --tool design_compiler --flow dcnxt      # dcnxt_shell instead of dc_shell

Flows of the same tool are alternatives meant to be compared, so each one runs in its own work directory (work/custom_freq_synthesis/vivado@power_opt/...), while all of them are exported into that tool’s single results file.

odatix analyze runs several tools at once, so its --flow accepts several values: a bare flow name applies to every selected tool, while tool:flow only applies to that tool.

Terminal
odatix analyze --tool vivado verilator --flow vivado:implementation

The flow a job ran with is recorded in the results file (flow meta key), so Odatix Explorer can compare the same design run through different flows.

What a tool runs can also be split into ordered steps (synthesis, place & route, bitstream…). Being stepped belongs to the tool, not to one dedicated flow: every flow of Vivado can be stopped wherever, for a custom frequency synthesis as well as for an fmax search. -u/--until stops a run at a given step, and a later run resumes at the first step left to do rather than redoing everything — see Splitting a job into steps.

Terminal
odatix synth -t vivado --until pnr                    # implement, no bitstream
odatix synth -t vivado                                # only runs the bitstream step
odatix synth -t vivado -f power_opt --until pnr       # same, on the power flow
odatix synth -t vivado --rerun-from pnr               # redo place & route onwards
odatix fmax -t vivado --until synthesis              # fmax from synthesis timing only

In the GUI, everything is on the Select an EDA Tool page, laid out inside each tool’s card: its flows as buttons, and, for a flow split into steps, its steps as “run up to here” buttons. Every one of them leads straight to the job settings, so a run stays one click away whatever the tool offers.

Usage by command

Initialization

Terminal
odatix --init            # interactive init
odatix init              # non-interactive init
odatix init --examples   # init and copy examples

Configuration

odatix config reads and writes the configuration files of the workspace: the same files documented in the reference, through the same API the graphical interface uses (see Configuration API for the whole surface and its Python form).

Terminal
odatix config show                      # what the workspace holds
odatix config arch list
odatix config arch set MyCPU clock_signal=clk fmax_synthesis.lower_bound=50
odatix config target enable vivado xc7a100t-csg324-1
odatix config job show fmax_synthesis
Option Description
-C, --directory Workspace directory (default: the current one).

Generation and replacement

Terminal
odatix generate
odatix generate -a odatix_userconfig/architectures
odatix generate -w odatix_userconfig/workflows

odatix replace -s "// <start>" -S "// </end>" -i input.v -r params.txt -o output.v

Synthesis and simulation

Terminal
odatix fmax --tool vivado
odatix fmax --tool design_compiler --from 100 --to 900

odatix synth --tool openlane --at 50 --at 100 --at 150
odatix synth --tool vivado --from 100 --to 500 --step 50

odatix sim

Place & route

Place & route a netlist another tool synthesized — see Place & route.

Terminal
odatix pnr --tool innovus --from-tool design_compiler
odatix pnr --tool icc2 --from-type fmax_synthesis
odatix pnr --tool innovus --until route

RTL analysis

Elaborate every configuration with one or several tools and report its status — see RTL analysis.

Terminal
odatix analyze
odatix analyze --tool vivado verilator genus
odatix analyze --tool vivado verilator --flow vivado:implementation

Workflows

Terminal
odatix workflow
odatix workflow -d -S experiments
odatix workflow -r   # resume existing workflow directories

Daemon commands

Terminal
odatix ls
odatix ls -S night

odatix monitor
odatix monitor -S nightly

odatix stop
odatix stop -S nightly
odatix stop --all

Results export

Terminal
odatix results
odatix results -u              # include benchmark values
odatix results -f csv          # csv, yml, or all
odatix results -t vivado -r results

odatix res_synth
odatix res_benchmark
odatix res_workflow
odatix res_simulation
odatix res_derived            # apply derived metrics to the result files

Cleanup

Terminal
odatix clean
odatix clean -f                # force cleanup for dangerous paths
odatix clean -i odatix_userconfig/clean.yml

Explorer

Terminal
odatix-explorer
odatix-explorer --network
odatix-explorer --port 8052 --input results
odatix-explorer --nobrowser --theme odatix_dark

See Odatix Explorer for the full option list.

Graphical interface

Terminal
odatix-gui
odatix-gui --network --port 8060

See The Odatix GUI for what each page does.

See also