From 515bf1cfe31d176b2047f5e7f6bd835c9db76520 Mon Sep 17 00:00:00 2001 From: Obijuan Date: Mon, 1 Apr 2024 19:07:21 +0200 Subject: [PATCH] apio sim documentation: Moved to a wiki page --- .../user_guide/project_commands/cmd_sim.rst | 66 ------------------- 1 file changed, 66 deletions(-) delete mode 100644 docs/source/user_guide/project_commands/cmd_sim.rst diff --git a/docs/source/user_guide/project_commands/cmd_sim.rst b/docs/source/user_guide/project_commands/cmd_sim.rst deleted file mode 100644 index cc407062..00000000 --- a/docs/source/user_guide/project_commands/cmd_sim.rst +++ /dev/null @@ -1,66 +0,0 @@ -.. _cmd_sim: - -apio sim -======== - -.. contents:: - -Usage ------ - -.. code:: - - apio sim [OPTIONS] - -Description ------------ - -Launch the verilog simulation using `GTKWave `_ from a **verilog test bench**. - -Required packages: ``scons``, ``iverilog``. - -.. image:: ../../../resources/images/gtkwave-simulation.png - -.. note:: - - GTKWave must be installed. - - +---------+-------------------------+ - | Debian | apt-get install gtkwave | - +---------+-------------------------+ - | Mac OSX | brew install gtkwave | - +---------+-------------------------+ - | Windows | apio install gtkwave | - +---------+-------------------------+ - -Options -------- - -.. option:: - -p, --project-dir - -Set the target directory for the project. - -Examples --------- - - -1. Simulate the *leds example* - -.. code:: - - $ apio sim - iverilog -B /path/to/lib/ivl -o leds_tb.out -D VCD_OUTPUT=leds_tb /path/to/vlib/system.v leds.v leds_tb.v - vvp -M /path/to/lib/ivl leds_tb.out - VCD info: dumpfile leds_tb.vcd opened for output. - End of simulation - gtkwave leds_tb.vcd leds_tb.gtkw - - GTKWave Analyzer v3.3.66 (w)1999-2015 BSI - - [0] start time. - [1000] end time. - WM Destroy - ================================== [SUCCESS] Took 1.96 seconds ============================== - -.. Executing: scons -Q sim -f /path/to/SConstruct