Documentation
riSim Studio user manual
riSim Studio is a VHDL simulation and verification environment built into VS Code, with command-line tools for scripting and CI. It detects VUnit testbenches in your project, compiles and simulates them with riSim’s own VHDL-2008 simulator, and shows live waveform views.
- The VS Code extension: testbench and testcase overview, waveform viewer, and IDE support.
- The command line tools: list, compile, and simulate testbenches, from a terminal or in CI.
- Project configuration: a single
risim-config.tomlfile to declare VHDL libraries, source files, and compile options.
VS Code and the command line tool share the compiled libraries and the results of a project, and the dashboard in VS Code shows all simulation runs.
Plans
- Free: 2 simulation threads per machine, no license key or registration needed (the free plan).
- Trial: riSim Pro on one machine for 30 days (trial). Until Pro is available, you can request a new trial once your last one has ended.
- Pro, available soon: node-locked seats for one machine each, and floating licenses.
The pricing page lists the details of each plan.
Pages
- Getting started: installing riSim, a first simulation, project configuration, and VUnit testbenches.
- VS Code extension: the Testbenches sidebar, waveforms, and the dashboard.
- Command-line tools: the
risimcommands, CI, and scripting. - Plans and licenses: activating licenses and working offline.
- Supported languages and limitations: currently available features.
Support
Report bugs and ask questions in the issue tracker on GitHub, with:
- riSim’s version (
risim --version, or the tooltip of the riSim item in the status bar), and your operating system; - what you did, what you expected, and what happened;
- the logs (in VS Code, on the command line), and the output of the testcase if one fails;
- if you can, a small
risim-config.tomland testbench that show the problem.
Issues are public, so leave out anything confidential, such as code you can’t share or license keys. For those, and for questions about your license or trial, write to support@risim-studio.com, or use the contact form. To report a security vulnerability, see Security.
The troubleshooting sections of the VS Code extension and the command-line tools help with common problems.