Add note to docs about disabling LAL stdout/stderr redirection in IPython/Jupyter when using CWInPy
As discussed in lscsoft/lalsuite#709 (closed), changes to the redirection of stdout/stderr for SWIG-wrapped LAL functions lead to a major slow-down of, e.g., LIGOTimeGPS
, when using IPython/Jupyter notebooks. This means that if using CWInPy to generate a long CW signal (for which the time stamps all get converted to LIGOTimeGPS
) it can be very slow (multiple minutes compared to a fraction of a second). To avoid this the redirection can be manually turned off, either globally or via a context manager (see lscsoft/lalsuite!2202 (merged)), so I should add a note to the CWInPy documentation (probably in the Heterodyned Data docs) mentioning this and recommending wrapping any simulation code in the context manager if working in IPython/Jupyter.