open-ephys / gui-docs Goto Github PK

Hi,

Try to use make latexpdf, but get this error:
Unknown graphics extension: .svg.

after google, this one works for me:
https://nbsphinx.readthedocs.io/en/0.4.2/markdown-cells.html#SVG-support-for-LaTeX

1. install inkscape
2. pip install sphinxcontrib-svg2pdfconverter
3. add sphinxcontrib.inkscapeconverter to the extensions list in your conf.py

Hope this can help someone encounter the same issue
Best,
Cequn

It could have the following:

1. Where to ask for support (currently in the FAQ section)
2. How to ask for support. Some ideas:

For troubleshooting GUI issues, always remember to provide:

• A full description of your issue, including screenshots or screen captures to help understand what is going on.
• A copy of the complete text in the debug console (copy & paste the contents from the console window that opens at the same time as the GUI). This lists all the steps that were performed in the GUI during the current session. If the GUI crashed and the console window shut down, then please send the activity log file. You can find the activity log file in the following folder: C:\ProgramData\Open Ephys\configs-api8.
• The saved config file (the settings.xml file from your recording, in the Record Node folder) to help diagnose any issues with the signal chain.

Check that this is the same as in the popup that comes up when there is a crash.

3. Other common issues and how to possibly fix them (@anjaldoshi has ideas on this)

I couldn't find an explicit definition of data stream, different data types and left to right processing.
I was also looking for a place to include internal lines that are not the more obvious 1-8 on the acq board.
So maybe a section defining how data is handled in general could help?

Maybe a good place for this is in page https://open-ephys.github.io/gui-docs/User-Manual/Exploring-the-user-interface.html
New title "Data processing" right before "Main components" could work.

Something like (please @jsiegle can you check for technical correctness and suitability):

The GUI processes different data types such as continuous signals, events, spikes and messages.

• Continuous signals: neural channels and auxiliary inputs on a headstage such as an accelerometer, as well as analog inputs acquired from other hardware.
• Events: discrete ‘high’ or ‘low’ signals from TTL lines in hardware or from other plugins that are used to indicate when something occured
• Spikes: used for waveforms, timestamps and cluster ID of spike events that are detected in neural data
• Text events: messages from user input or plugin communications

Data is processed in the signal chain from left to right in what are called "data streams". There can be multiple data streams in parallel. Data streams deal with data from selected sources (for example, a headstage or a file), as well as internal TTL lines. The GUI supports 256 TTL lines internally. A subset of these is accessible by hardware. For example, TTL lines 1-8 can be accesed by connecting an I/O board to the digital input or output of the Open Ephys Acquisition Board.

The last part might be a handful for the first section of the docs, but it also immediately gives you an idea of where data lives in the software and what you are going to be juggling with. I didn't do a pull request so we can discuss.

From Discord user ant_blot: On some (older) windows computer starting the gui crashes with "no audio device" message. It took us a while to realise that it was because of a Windows "feature". If there is no audio output (screen with DVI, no onboard speaker or headphone connected), windows disables completely the audio device (in the task bar the volume icon has a red cross like when it's on mute). The issue can be solved by connecting a jack cable in the headphone connector (no need to have speakers, just put something in the connector and let the cable hang loose and it works). It's not a gui issue per se but it might be good to add that in the documentation/troubleshooting somewhere

Might be a good idea to add a couple pages covering how to load data recorded by GUI in Matlab and Python. This could just even be examples.

I think the use of text (instead of primitive shapes) in the logo SVG is causing the font to look inconsistent across browsers/systems.
Might want to use PNG instead or use font outlines.

I can't seem to find them and it would be helpful to have the plugin functionality documented

Or, if this is difficult to do on the menu, have a page listing them by plugin type.
This is helpful to help navigate plugins when you don't know what they do.
Eg: browse the plugin list by "Sink" to understand the different ways in which the acq board can interact with other devices via the GUI.