Plans and licenses
riSim Studio user manual
Without a license key, riSim runs on the free plan. A trial or a paid plan comes with a license key, which you activate on each machine that uses it.
- Trial: one machine, for 30 days from its issue.
- Node-locked seat: one machine per seat, with the simulation threads of the plan on that machine.
- Floating license: any number of machines, which share the simulation threads of the license.
The pricing page has the simulation threads of each plan; Pro, with its seats and floating licenses, will be available soon.
Simulation threads
riSim limits how many simulations run at the same time by simulation threads. Each plan has a number of them: per machine on the free plan and a node-locked seat, and for all machines together on a floating license.
Each simulation currently runs on one thread. More threads run more testcases at the same time, but don’t make a single simulation faster.
How threads are counted
- Compiling uses no threads.
- A running simulation uses one thread. A testcase waits for its thread before its run starts, holds it while its design is loaded, elaborated, and simulated, and gives it back when the run ends.
- A paused simulation keeps one thread, for example a testcase started in paused mode for the waveform view.
A simulation that you run interactively, for example when you debug it in VS Code, pauses when it reaches VHDL’s
stop, and keeps its thread until you terminate it. - A finished simulation, uses none, also while its waveforms stay open.
- Per machine: on the free plan and on a node-locked seat, all simulations of a machine count together: those of every VS Code window, every command-line run, and every user of the machine.
- Floating licenses: the simulations of all machines on which the license key is activated count together, against the threads of the license.
When all threads are in use
Testcases beyond the limit wait in a queue, and start as soon as a thread is free.
The dashboard in VS Code and the progress of risim simulate show which testcases wait, and why:
- all threads of the plan are in use by the other simulations that riSim runs for you;
- all threads of the machine are in use, also by simulations that other users of the machine or separate runs, such as CI jobs, started;
- on a floating license, all threads of the license are in use, by the simulations of all its machines.
On a floating license, testcases wait for a thread of the license when all are in use; they don’t fall back to the free plan.
Using fewer threads
By default, a run uses at most one thread per physical core of the machine, and at most the threads of the plan.
To change this, set risim.simulation.threads in VS Code, or pass --threads to risim simulate:
cores: one thread per physical core (the default);smt: one thread per logical core, with simultaneous multithreading;- a number, such as
4.
The limit of the plan applies, too.
The free plan
Without a license key, riSim runs on the free plan:
- 2 simulation threads per machine, shared by all users and runs of the machine;
- on any number of machines;
- no license key and no registration;
- riSim doesn’t contact the license server.
Simulations beyond the limit wait in the queue (when all threads are in use). The status bar’s tooltip in VS Code shows the plan:

The free plan is open to everyone, also for private use. Pro is sold to businesses only, and trials are for businesses too. On every plan, riSim is used under the license terms, which riSim points you to once per version until you accept them (accepting the license terms).
Physical machines only
The free plan is only for computers whose operating system runs directly on their hardware. It isn’t for virtual machines or containers, also not on your own computers, for example:
- cloud instances;
- virtual machines on a desktop or a server;
- Docker and other containers, also in CI pipelines;
- VS Code dev containers;
- WSL 2 on Windows.
These count as running directly on the hardware:
- the operating system that a computer boots, also when it runs a hypervisor itself, for example Windows with Hyper-V or virtualization-based security turned on, or a host that runs virtual machines;
- applications in a Flatpak or Snap sandbox;
- a physical machine that you use through VS Code’s Remote-SSH, since riSim runs on that machine.
In virtual machines and containers, riSim needs a license: for now a trial, and a paid plan once Pro is available. For CI, see CI and unattended machines.
Future versions of riSim may check this, and refuse the free plan in virtual machines and containers; the release notes will announce it.
Changes of the free plan
A new version of riSim may change the limits or features of the free plan, for example by making a feature available only in paid plans. The release notes of the first version with such a change announce it, and earlier versions keep their limits and features.
Trials
Request a trial on the trial page, and confirm your email address with the link that you get; the license key then comes by email. Activate it on the machine you want to try riSim on, as below.
Until Pro is available, you can request a new trial once your last one has ended, and activate it on the same machine or on another one. Activating the new key replaces the ended trial on the machine.
Activating a machine
In VS Code, run riSim: Enter License Key from the command palette, accept the license terms, enter the key from your purchase or trial email, and then the machine’s name. On the command line, run:
risim license activate <key>
Activating a license key needs your acceptance of the license terms of your version of riSim (accepting the license terms).
The license holder sees the machine under its name, for example with risim license list-machines.
It is the machine’s host name, unless you choose another one when you activate the machine: in VS Code in the second box, on the command line with --name <name>, and for the key in RISIM_LICENSE with the environment variable RISIM_MACHINE_NAME (CI).
The name needn’t name a person; a neutral name, such as lab-pc-3, will do.
A machine that is activated on the license already keeps its name; to change it, deactivate the machine and activate it again.
risim license activate - reads the key from the first line of its input instead, so that other users of the machine can’t see it in the list of processes.
Activating needs a connection to the license server license.risim-studio.com.
The data sent by riSim is described in What activating sends, and the software privacy notice describes the data stored by the license server.
riSim in VS Code and on the command line uses the new license within seconds; the status bar shows the plan.
The activation belongs to your user account on the machine.
Other users of the same machine activate it with the same key, and share its seat.
To see the plan of this machine, run riSim: Show License, or risim license status, which doesn’t contact the license server.
The command-line tools list all risim license commands.
Accepting the license terms
riSim is licensed under the riSim Studio License Terms; each version of riSim refers to the version of the terms it was released with, which risim --help and risim license status name.
- Activating a license key asks you to accept them, unless you have accepted that version on the machine already: in VS Code in a dialog before the key, on the command line with a question on the terminal.
risim license activate --accept-termsaccepts them without the question, for scripts; without a terminal, and without--accept-terms, the activation fails. For the key inRISIM_LICENSE, setRISIM_ACCEPT_TERMSto the version of the terms (CI). - Without an express acceptance, on every plan, riSim points you to the terms once per version: the testbench commands and
risim runon the command line, and VS Code in a notification. By continuing to use riSim, you accept them. risim license accept-terms, or Accept in VS Code’s notification, accepts them explicitly.
riSim keeps the version you accepted and when, and the version it last pointed you to, in the license directory of the riSim store, and doesn’t transmit them. Renewing an activation doesn’t ask again, nor does riSim when it activates the machine’s key again by itself, for example after the license server removed a floating license’s machine.
What activating sends
When riSim activates a machine, it sends to the license server license.risim-studio.com:
- the license key;
- a fingerprint of the machine: a cryptographic hash of the host name, keyed with the operating system’s machine ID, from which the machine ID can’t be recovered;
- the machine’s name: its host name, unless you choose another name (activating a machine);
- the platform, such as
linux-x86_64; - riSim’s version.
riSim reads the machine ID only when it activates a license, and while one is activated; on the free plan, it reads nothing. Where the operating system has no machine ID, as in many containers, riSim creates a random ID when it activates a license, and keeps it in the license directory of the riSim store, for the user, until the license is deactivated. Each user and each store of such a machine then counts as a machine of its own, and so does a new container whose store is new; a container that keeps its store, for example in a volume, stays the same machine.
While it runs, riSim renews the activation about once a day, and on a floating license it reports every 2 minutes how many threads the machine uses. Your designs, simulation results, waveforms, and logs aren’t sent. Like any server, the license server also sees the IP address that the machine connects from. The software privacy notice describes what the license server stores, and for how long.
Seats
A node-locked seat is used by one machine at a time.
riSim tells machines apart by the operating system’s machine ID and the machine’s host name.
Where the operating system has no machine ID, as in many containers, riSim creates a random ID when it activates a license, and keeps it in the user’s riSim store until the license is deactivated; each user and each store of such a machine then counts as a machine, and takes a seat, of its own.
If you change a machine’s host name, it counts as a new machine and needs a new activation: run risim license deactivate, before or after renaming, then activate the key again.
The name you choose when you activate a machine is only a label, and doesn’t change which machine it is.
If all seats of a license are in use, activating another machine fails; deactivate a machine first.
On a floating license, machines take no seat: any number of them can be activated, and they share the license’s threads (how threads are counted).
Moving a seat to another machine
- On the old machine, run
risim license deactivate, which frees its seat.risim self uninstalldeactivates the machine too when it removes riSim’s data; while the VS Code extension still uses riSim, it keeps both, unless you pass--all. Uninstalling only the VS Code extension doesn’t deactivate the machine. - On the new machine, activate the key.
Moving a seat is meant for a lasting change of machine, such as a new computer, not for switching back and forth between machines; see the license terms. Machines that are used only for a short time, such as CI runners, need a floating license (CI and unattended machines).
Machines you no longer have
If the old machine is gone or broken, deactivate it from another machine on which the license is activated:
risim license list-machines
risim license deactivate --machine <ID>
If no other machine is activated with the license, for example because the lost machine had its only seat, write to support@risim-studio.com.
Listing the machines of a license
risim license list-machines lists the machines on which the license of this machine is activated: the ID and name of each, the date of its activation, and which one is this machine.
With --json, it also shows each machine’s platform and, on a floating license, its last contact with the license server.
Working offline
The free plan doesn’t contact the license server. A trial or a paid plan needs it to activate a machine, and from time to time afterwards.
Node-locked seats and trials
While riSim runs, it renews the activation about once a day.
If it can’t reach the license server, it keeps trying, and the machine keeps its license for 14 days since the last renewal.
risim license status shows that date as “checked out until”.
After that, riSim runs with the limits of the free plan until it reaches the license server again, and then uses the license again.
Floating licenses
A floating license needs a connection to the license server while simulations use its threads: riSim gets the threads from the license server, and reports regularly which of them the machine still uses.
If the connection is lost, running simulations keep their threads for 24 hours since the last contact. Simulations that need a new thread from the license server meanwhile run on the free plan. After the 24 hours, the free plan applies to all simulations of the machine, until riSim reaches the license server again.
When the license isn’t used
When riSim can’t use the license of the machine, it continues with the limits of the free plan instead of failing: simulations beyond its limits wait for a thread (how threads are counted).
The riSim item in the status bar in VS Code then shows a warning sign ; its tooltip and riSim: Show License say why, and on a node-locked seat or a trial risim license status does too.
To make a run fail instead, see requiring a license.
- The trial or the subscription has ended: until Pro is available, request a new trial. In virtual machines and containers, riSim may no longer be used until you activate a new trial (physical machines only).
- All seats are in use: deactivate another machine first (seats).
- The machine was offline too long: riSim uses the license again once it reaches the license server (working offline).
- The machine was renamed: it counts as a new machine and needs a new activation (seats).
A machine whose license has ended keeps trying to renew it until you deactivate it with risim license deactivate.
Privacy and data protection
Does riSim send our designs or results to xq-Tec?
No. riSim simulates on your computers; designs, simulation results, waveforms, and logs stay there. No transmission of telemetry, usage statistics, or crash reporting takes place.
What does the license server receive?
On the free plan, nothing: riSim doesn’t contact the license server.
On a trial or a paid plan, the license server receives, for each machine on which the license key is activated, the data listed in what activating sends: a fingerprint of the machine, its name, its platform, and riSim’s version. Like any server, it also sees the IP address that the machine connects from. riSim renews the activation about once a day while it runs, and on a floating license reports every 2 minutes which simulation threads the machine uses. It sends nothing about who uses the machine, which designs are simulated, or which testcases run. The software privacy notice describes what the license server stores, and for how long.
What does the license holder see?
Anyone who has activated the license key on a machine can list the license’s machines with risim license list-machines.
For each machine, it shows an ID, its name, and the date of its activation.
With --json, it also shows the machine’s platform and, on a floating license, the time of its last contact with the license server, which riSim contacts while it runs on the machine.
It doesn’t show who uses a machine, what was simulated, or for how long.
Can a machine’s name identify a person?
The machine’s name is its host name, unless another name is chosen when the machine is activated: in VS Code, in the box after the license key; on the command line, with risim license activate --name <name>; on a build server, with the environment variable RISIM_MACHINE_NAME (activating a machine).
If host names in your organization contain names of persons, choose neutral names, such as lab-pc-3, when you activate the license on the machines.
The name is only a label: it doesn’t change which machine it is for the license.