Skip to content

Commit

Permalink
Add doc about the wave / test folder location
Browse files Browse the repository at this point in the history
  • Loading branch information
Dolu1990 committed Jan 31, 2024
1 parent 39a5739 commit 01659ba
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions source/SpinalHDL/Simulation/bootstraps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,9 +156,14 @@ Note is it equivalent to:
simThread.suspend() // Avoid the "doSim" completion
}
.. _env_SPINALSIM_WORKSPACE:
The location where the simulation files will be placed is defined by default in $WORKSPACE/$COMPILED.

- $WORKSPACE being by default ``simWorkspace``, you can override it with the ``SPINALSIM_WORKSPACE`` environnement variable.
- $COMPILED being the name of the toplevel being simulated.
- The location of the wave file depend the backend used. For verilator it will be in the folder (``$WORKSPACE/$COMPILED/$TEST`` by default).
- For the verilator backend, you can override the location of the test folder via the ``SimConfig.setTestPath(path)`` function.
- You can retrieve the location of the test path durring simulation by calling the currentTestPath() function.

Note that by default, the simulation files will be placed into the ``simWorkspace/xxx`` folders. You can override the simWorkspace location by setting the ``SPINALSIM_WORKSPACE`` environment variable.

Running multiple tests on the same hardware
-------------------------------------------
Expand Down

0 comments on commit 01659ba

Please sign in to comment.