is there an option to get an ouput of the non-state variable? about pyrates HOT 2 CLOSED

Hi Nina,

thank you for giving PyRates a try and for bringing this to my attention!
Indeed, it is not supported at the moment to save non-state variables as output variables.
The issue with supporting non-state variables is that it leads to compatibility issues with external differential equation solving tools such as scipy.integrate.solve_ivp. These tools require a function that returns only a state-vector which has the same dimensionality as the differential equation system that governs the dynamics.

I have been thinking of a way to include this feature, but have not yet found a way to do it without substantial drawbacks.
At the moment, there are two work-arounds you could use:

(I) Store whatever state-variable you use your wrap function on as an output and manually apply the wrap function after the simulation.

OR

(II) Add an observer state variable to your model that tracks the dynamics of your variable of interest with a small low-pass filtering time constant. If you have a variable wrap, you could include d/dt wrap_obs = (wrap-wrap_obs)/tau_obs, where tau_obs is smaller than any other time constant in your system.

Let me know if I can help any further!

from pyrates.

Hi,

Ok, thank you for the information. I have been using the first option you mentioned, but as I saw the option to wrap angle theta in sinus function in your exemplary YAML model definition for Kuramoto oscillator, I thought I have missed something.

Thank you also for a quick response!
Best,
Nina

from pyrates.