Delete every simulation of a variant and forget its settings.
Variants that take their particles from it with from: are deleted
too. Afterwards the variant runs again as new on the next
run(), with whatever settings config.yaml now gives it.
- Parameters:
variant (str) – Variant name, realization group (every realization is deleted),
or a name config.yaml no longer declares (orphans()).
- Returns:
The simulations that were deleted.
- Return type:
list[SimID]
- Raises:
KeyError – If the project has no registered variant or group by that name.