You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/User-Manual/Whats-new-in-v100.rst
+14-11
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@
6
6
What's new in version 1.0
7
7
############################
8
8
9
-
The Open Ephys GUI has been under continuous development for more than a decade, and it has been used to collect high-quality electrophysiology data for hundreds of publications (see `open-ephys.org/publications <http://open-ephys.org/publications>`_ for some examples). Nevertheless, the developers did not feel ready to call a release "version 1.0" until now. This version (which will be widely available in early 2025) is the result of many years of polishing, streamlining, and testing. It should feel familiar to any long-time users of the software, while also being more approachable for anyone trying it out for the first time.
9
+
The Open Ephys GUI has been under continuous development for more than a decade, and it has been used to collect high-quality electrophysiology data for hundreds of publications (see `open-ephys.org/publications <http://open-ephys.org/publications>`_ for some examples). Nevertheless, the developers did not feel ready to call a release "version 1.0" until now. This release (which will be widely available in early 2025) is the result of many years of polishing, streamlining, and testing. It should feel familiar to any long-time users of the software, while also being more approachable for anyone trying it out for the first time.
10
10
11
-
This page documents the major changes that will be available in this release. Importantly, there are many things that we did not change, such as the data format, HTTP server commands, and config files (e.g. :code:`settings.xml`). So configurations from v0.6.x can be loaded in version 1.0, and any code written to interface with the GUI or its output files will continue to work as expected.
11
+
This page documents the major changes that will be available in this release. Importantly, there are many things that we did not change, such as the data format, HTTP server commands, and :code:`settings.xml` files. So configurations from v0.6.x can be loaded in version 1.0, and any code written to interface with the GUI or its output files will continue to work as expected, with a few minor exceptions.
The Graph Viewer provides an overview of the connections between all of the plugins that are currently processing data, making it easier to navigate signal chains with multiple source nodes or branch points. In version 1.0, the Graph Viewer connections flow from left to right (rather than top to bottom), mirroring the layout of plugins in the editor viewport at the bottom of the window. In addition, plugin parameters are now accessible via the Graph Viewer, and all parameters are linked to the widgets in the plugin editor. For example, the low and high cutoffs of the Bandpass Filter can be changed *either* via the Graph Viewer or the plugin editor. This makes it easier to check the state of parameters across multiple data streams, and even makes it possible to interact with the signal chain through the Graph Viewer alone.
26
+
The Graph Viewer provides an overview of the connections between all of the plugins that are currently processing data, making it easier to navigate signal chains with multiple source nodes or branch points. In version 1.0, the Graph Viewer connections flow from left to right (rather than top to bottom), mirroring the layout of plugins in the editor viewport at the bottom of the window. In addition, plugin parameters are now accessible via the Graph Viewer, and all parameters are linked to the widgets in the plugin editor. For example, the low and high cutoffs of the Bandpass Filter can be changed *either* via the Graph Viewer or the plugin editor. This makes it easier to check the state of parameters across multiple data streams, and even makes it possible to conduct all interactions with the signal chain via the Graph Viewer alone.
The Data Viewport, which holds the Graph Viewer alongside plugin visualizers, can now be split vertically, allowing multiple visualizers to appear side by side. To add a second column of tabs, simply click the "new tab" button in the lower right of the viewport. Any new tabs that are created will appear in the right column, or tabs can be dragged between columns. In version 1.0, tabs can also be reordered and renamed. If the "Info" or "Graph" tabs are closed, they can be reopened via the "View" menu or by pressing shift-I or shift-G.
34
+
The Data Viewport, which holds the Graph Viewer as well as plugin visualizers, can now be split vertically, allowing multiple visualizers to appear side by side. To add a second column of tabs, simply click the "new tab" button in the lower right of the viewport. Any new tabs that are created will appear in the right column, and tabs can be dragged and dropped between columns. Tabs can also be reordered and renamed. If the "Info" or "Graph" tabs are closed, they can be reopened via the "View" menu or by pressing shift-I or shift-G.
The Open Ephys console is now embedded in the main GUI window. Previously, the console would launch automatically on Windows, but would not appear on Mac or Linux unless the GUI was launched via a terminal. The console can be activated via the "View" menu, or by pressing shift-C. The console output is automatically written to a log file wherever the GUI's configuration files are stored. Console messages can be copied by pressing the "Copy All" button or selected a subset of text in the console window.
42
+
The Open Ephys console is now embedded in the main GUI window. Previously, the console would automatically launch in a separate window on Windows, but would not appear on Mac or Linux unless the GUI was run via a terminal. The new embedded console can be activated via the "View" menu, or by pressing shift-C. The console output is automatically written to a log file wherever the GUI's configuration files are stored. Console messages can be copied by pressing the "Copy All" button or selected a subset of text in the console window.
Custom text annotations can now be saved via a pop-up window. Assuming recording is active, these annotations will be timestamped and written automatically by all Record Nodes. One advantage of using the message window (as opposed to the message bar at the bottom of the GUI's main window) is that the message will be tagged with the time the window was opened, rather than the time the "send" button is pressed. Thus, the window can be launched when an interesting event occurs, and the user can take as much time as needed to enter custom text describing the event.
51
+
52
+
50
53
More extensive undo/redo support
51
54
----------------------------------
52
55
@@ -78,7 +81,7 @@ There are at least three areas where performance has improved in version 1.0:
78
81
79
82
- **More efficient data transfer from source plugins.** The time spent copying data into the overall signal chain has been reduced, allowing source plugins such as :ref:`neuropixelspxi` and :ref:`acquisitionboard` to use less CPU cycles during acquisition.
80
83
81
-
- **Multithreaded filtering.** The :ref:`bandpassfilter` now uses 4 threads by default, and this number can be increased to 64. Filtering is typically the biggest contributor to processing latency; now the impact of filter nodes will be greatly reduced.
84
+
- **Multithreaded filtering.** The :ref:`bandpassfilter` now uses 4 threads by default, and this number can be increased to 64. Filtering is typically the biggest contributor to processing latency. In version 1.0, the impact of filter nodes on the CPU meter will be greatly reduced.
The version 1.0 :ref:`recordnode` uses a new real-time synchronization algorithm that is more accurate and robust. Previously, synchronization pulses less than 50 ms in duration could confuse the algorithm, making it necessary to revert to offline synchronization. Now, pulses as short as 1 ms can be detected reliably, meaning "barcode"-like signals can now be reliably used for online synchronization. The new algorithm may take a bit longer to synchronize, but it will be far less likely to become desychronized over time.
93
+
The GUI's :ref:`recordnode` in version 1.0 uses a new real-time synchronization algorithm that is more accurate and robust. Previously, synchronization pulses less than 50 ms in duration could confuse the algorithm, making it necessary to revert to offline synchronization to align multiple data streams. Now, pulses as short as 1 ms can be detected, meaning "barcode"-like signals can now be reliably used for online synchronization. The new algorithm may take a bit longer to synchronize, but it will be far less likely to become desychronized over time.
91
94
92
95
In addition, the following synchronization statistics for each stream can now be viewed in the Record Node's stream selector: relative start time, elapsed time since latest sync pulse was received, and the overall "sync tolerance" (maximum difference between the estimated and measured time of each sync pulse).
93
96
@@ -101,7 +104,7 @@ The Open Ephys GUI application on macOS is now signed with an Apple Developer ID
101
104
New testing infrastructure
102
105
============================
103
106
104
-
To facilitate automated testing on cloud servers, the GUI now can run in "headless mode." This also works on your local machine by launching the GUI from the command line with the "--headless" option. Interacting with the GUI in headless mode requires use of the built-in HTTP server.
107
+
To facilitate automated testing on cloud servers, the GUI now can run in "headless mode." This also works on your local machine by launching the GUI from the command line with the :code:`--headless` option. Interacting with the GUI in headless mode requires use of the built-in HTTP server.
105
108
106
109
The GUI now includes unit tests for key classes via the Google Test package, which are run before each new release. This will ensure critical functionality remains intact as new contributors are onboarded.
107
110
@@ -111,19 +114,19 @@ The `open-ephys-test-suite <https://github.com/medengineer/open-ephys-test-suite
111
114
Plugins
112
115
=========
113
116
114
-
All officially supported :ref:`plugins` have been updated to work with version 1.0 of the GUI. This included changes to the UI for compatibility with the GUI's new color themes. Plugins included in any loaded signal chains will be automatically installed; additional plugins can be added via the Plugin Installer.
117
+
All officially supported :ref:`plugins` have been updated to work with version 1.0 of the GUI. Plugins included in any loaded signal chains will be automatically installed; additional plugins can be added via the Plugin Installer.
115
118
116
119
.. note:: The Open Ephys plugin API has been updated for version 1.0, which means that plugins compiled for version 0.6.x won't work out of the box. Feel free to reach out to [email protected] for help migrating any custom plugins to the latest API.
117
120
118
121
Renamed plugins
119
122
----------------
120
123
121
-
All versions of the Open Ephys acquisition board are now supported by one plugin, called "Acquisition Board." The "OE FPGA Acquisition Board" plugin is no longer needed. The "Intan RHD USB" plugin, which was previously included as one of the "Rhythm Plugins," due to its use of Intan's Rhythm API, is now installed separately.
124
+
All versions of the Open Ephys acquisition board are now supported by one plugin, called "Acquisition Board." The "OE FPGA Acquisition Board" plugin is no longer needed. The "Intan RHD USB" plugin, which was previously included as one of the "Rhythm Plugins," due to its use of Intan's Rhythm API, must now be installed separately.
122
125
123
126
Deprecated plugins
124
127
--------------------
125
128
126
-
The :ref:`riveroutput` plugin has been deprecated, as this was rarely used.
129
+
The :ref:`riveroutput` plugin has been removed from the plugin installer, as this was rarely used.
0 commit comments