-
Notifications
You must be signed in to change notification settings - Fork 177
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
pysim: option to capture simulation output in a python object #327
Comments
Yes, it would make perfect sense as a workflow. Do you have any preferences regarding an exported API here? |
Thinking about the API, I'd have no preference -- whatever's most convenient on the nmigen side. I guess for consistency we could have a context manager similar to
where |
I'd like us to make sure that this can be used incrementally - that is, run for N clock ticks and return the traces, do something with them, then run for M more clock ticks and return those traces. This ties into my dream of an interactive simulator. Note that I don't think the context manager API is incompatible with the above, just making a use case known. |
Yes, that would be awesome! I was thinking of the possibility of making interactive simulations with ipywidgets, but if making it iterative will complicate the API or the implementation of the simple case, perhaps the simple case should take priority. |
It wouldn't be hard to make it iterative; the VCD writer isn't, but only due to limitations of the VCD file format. |
FWIW, I ended up just passing a StringIO object to the Therefore, I think this issue can be deprioritized or closed altogether. |
I think it would be an appropriate and highly useful feature to have: your workaround is... let's say suboptimal (no shade but it's pretty inefficient), and what @awygle wants here is also very reasonable. |
Adds an Observer interface to the simulator, allowing arbitrary code to receive values from the simulation. The implementation is based on the implementation of write_vcd. An obvious next step would be to make _VCDWriter a subclass of Observer, then - rewrite Simulator.write_vcd() as a call to Simulator.oberve() - remove PySimEngine._vcd_writers and associated code. This commit is an RFC for amaranth-lang#327. It is not intended to be submitted as-is.
This looks like a typical application for an Observer. The Observer is registered with the simulator, which then notifies it of interesting events. I made a draft PR as an RFC. I think this is general enough to:
Please send comments. |
Would it make sense to have a way to capture simulation output in a python object, rather than having to use a vcd file and a separate reader program?
I'm building a physics simulator in nmigen and it would be super helpful when debugging to be able to plot a signal's trace (over eg 1000 timesteps) in matplotlib, within the same python session as the simulation.
Does this make sense as a workflow?
Is there already a way to do this?
The text was updated successfully, but these errors were encountered: