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   |
+-------------------+-------------------------------------------+--------------------------------------------------------------------+
| Simulation        | ``odatix sim``                            | Run simulations                                                    |
+-------------------+-------------------------------------------+--------------------------------------------------------------------+
| Synthesis         | ``odatix fmax --tool vivado``             | Run synthesis + place&route in *Vivado*                            |
|                   +-------------------------------------------+--------------------------------------------------------------------+
|                   | ``odatix fmax --tool openlane``           | Run synthesis + place&route in *Openlane*                          |
|                   +-------------------------------------------+--------------------------------------------------------------------+
|                   | ``odatix fmax --tool design_compiler``    | Run synthesis in *Design Compiler*                                 |
+-------------------+-------------------------------------------+--------------------------------------------------------------------+
| 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``                       | Explore results in a web app (localhost only)                      |
|                   +-------------------------------------------+--------------------------------------------------------------------+
|                   | ``odatix-explorer --network``             | Explore results in a web app (network-accessible)                  |
+-------------------+-------------------------------------------+--------------------------------------------------------------------+
| Others            | ``odatix --help``                         | Display a list of useful commands                                  |
|                   +-------------------------------------------+--------------------------------------------------------------------+
|                   | ``odatix clean``                          | Clean current repository                                           |
+-------------------+-------------------------------------------+--------------------------------------------------------------------+