Useful commands
===============

Odatix commands
---------------

+-------------------+-----------------------------------------------+-----------------------------------------------------------------------------+
| 🏷️ Category       | ⌨️ Command                                    | 💡 Role                                                                     |
+===================+===============================================+=============================================================================+
| Initialization    | ``odatix --init``                             | Create configuration files in current directory.                            |
|                   |                                               | Asks to confirm and to add examples                                         |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix init``                               | Create configuration files only in current directory                        |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix init --examples``                    | Create configuration files in current directory and add examples            |
+-------------------+-----------------------------------------------+-----------------------------------------------------------------------------+
| Generation        | ``odatix generate``                           | Generation configurations (see :doc:`/userguide/configuration_generation`)  |
+-------------------+-----------------------------------------------+-----------------------------------------------------------------------------+
| Simulation        | ``odatix sim``                                | Run simulations                                                             |
+-------------------+-----------------------------------------------+-----------------------------------------------------------------------------+
| Fmax              | ``odatix fmax --tool vivado``                 | Find Fmax for synthesis + place&route with *Vivado*                         |
| Synthesis         +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix fmax --tool openlane``               | Find Fmax for synthesis + place&route with *Openlane*                       |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix fmax --tool design_compiler``        | Find Fmax for synthesis with *Design Compiler*                              |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix fmax ---from XXX --to YYY``          | Find Fmax from XXX MHz to YYY MHz                                           |
+-------------------+-----------------------------------------------+-----------------------------------------------------------------------------+
| Custom            | ``odatix freq --tool vivado``                 | Run synthesis + place&route with *Vivado* at desired frequencies            |
| Frequency         +-----------------------------------------------+-----------------------------------------------------------------------------+
| Synthesis         | ``odatix freq --tool openlane``               | Run synthesis + place&route with *Openlane* at desired frequencies          |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix freq --tool design_compiler``        | Run synthesis with *Design Compiler* at desired frequencies                 |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix freq --at XXX --at YYY``             | Run synthesis at frequency XXX MHz and YYY MHz                              |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix freq --from XXX --to YYY --step ZZZ``| Run synthesis at frequencies from XXX MHz to YYY MHz by steps of ZZZ MHZ    |
+-------------------+-----------------------------------------------+-----------------------------------------------------------------------------+
| Data Export       | ``odatix results``                            | Export results without benchmarks                                           |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix results -u``                         | Export results including benchmarks                                         |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix res_benchmark``                      | Export benchmark results from simulations only                              |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix res_synth``                          | Export synthesis results only                                               |
+-------------------+-----------------------------------------------+-----------------------------------------------------------------------------+
| Data Exploration  | ``odatix-explorer``                           | Display results in an interactive web app (localhost only)                  |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix-explorer --network``                 | Display results in an interactive web app (network-accessible)              |
+-------------------+-----------------------------------------------+-----------------------------------------------------------------------------+
| Others            | ``odatix --help``                             | Display a list of useful commands                                           |
|                   +-----------------------------------------------+-----------------------------------------------------------------------------+
|                   | ``odatix clean``                              | Clean current repository                                                    |
+-------------------+-----------------------------------------------+-----------------------------------------------------------------------------+