Skip to content

Commit 97dd4f3

Browse files
authored
Merge pull request #53 from open-ephys/version-locations
mention alpha release location
2 parents 0d8c70a + 4a0e67a commit 97dd4f3

File tree

3 files changed

+33
-11
lines changed

3 files changed

+33
-11
lines changed

Pipfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ verify_ssl = true
77
sphinx = "*"
88
pydata-sphinx-theme = "0.13.3"
99
sphinx-tabs = "*"
10-
make = "*"
10+
make = "*"

source/User-Manual/Installing-the-GUI.rst

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,30 @@ Installing the GUI
77

88
The Open Ephys GUI works equally well on Windows, Linux, and macOS, so which platform you choose is mostly up to you. However, there are some plugins (such as Neuropixels) that are currently only available for Windows. We recommend reading through the documentation of any :ref:`plugins` you plan to use to find out about potential limitations.
99

10-
Windows
11-
########
10+
Choose what version of the GUI you would like to download and follow the installation instructions for Windows, Linux or macOS below.
11+
12+
Versions
13+
#########
14+
15+
Latest stable version
16+
----------------------------
17+
18+
We recommend installing the latest stable version from `this page`_.
19+
20+
Pre-releases
21+
----------------------------
22+
23+
Looking for the pre-release of :ref:`version 1.0 <whatsnewinv100>`? You can download it from: https://openephys.jfrog.io/ui/native/GUI-binaries/1.0.0-alpha/
24+
25+
.. Note:: You need version 1.0 of the Open Ephys GUI to use the 3rd Gen Acquisition Board's 3D capabilities.
26+
27+
Previous versions
28+
----------------------------
29+
30+
Download a **.zip** file for any previous release via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/
31+
32+
Windows installation
33+
##########################
1234

1335
Via installer (recommended)
1436
----------------------------
@@ -26,7 +48,7 @@ Via installer (recommended)
2648
Via .zip file
2749
--------------
2850

29-
1. Download a **.zip** file for any previous release via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/windows/
51+
1. Download a **.zip** file via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/windows/
3052

3153
2. Drag and drop the downloaded and unzipped folder to the location of your choice, and rename it "Open Ephys"
3254

@@ -36,8 +58,8 @@ Via .zip file
3658

3759
.. note:: If this is your first time running the GUI on a particular machine, you will need to install the `Visual Studio 2015, 2017, 2019, and 2022 redistributable package`_ before opening the application. This only applies to the .zip download, as this package will be added automatically when using the Windows installer.
3860

39-
Linux
40-
######
61+
Linux installation
62+
########################
4163

4264
Via installer (Ubuntu only)
4365
-----------------------------
@@ -80,7 +102,7 @@ The GUI is available at the gentoo science overlay.
80102
Via .zip file (all distros)
81103
----------------------------
82104

83-
1. Download a **.zip** file for any previous release via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/linux/
105+
1. Download a **.zip** file via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/linux/
84106

85107
2. Drag and drop the downloaded and unzipped folder to the location of your choice, and rename it "Open Ephys"
86108

@@ -93,8 +115,8 @@ Via .zip file (all distros)
93115
6. Double-click the **open-ephys** executable (or enter :code:`./open-ephys` in the terminal) to run the application.
94116

95117

96-
macOS
97-
######
118+
macOS installation
119+
########################
98120

99121
Via DMG (recommended)
100122
----------------------
@@ -114,7 +136,7 @@ Via DMG (recommended)
114136
Via .zip file
115137
--------------
116138

117-
1. Download a **.zip** file for any previous release via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/mac/
139+
1. Download a **.zip** file via this link: https://openephys.jfrog.io/ui/native/GUI-binaries/Release/mac/
118140

119141
2. Drag and drop the downloaded and unzipped folder to the location of your choice, and rename it "Open Ephys"
120142

source/User-Manual/Recording-data/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ In order to align events and continuous data from different streams, these strea
136136
If the streams were not synchronized online, they can be synchronized offline assuming all streams share at least one event line in common. See the :ref:`datasynchronization` tutorial for more information about synchronizing data streams.
137137

138138
.. _NumPy: https://numpy.org/
139-
.. _Neurodata Without Borders: https://neurodatawithoutborders.github.io/
139+
.. _Neurodata Without Borders: https://nwb.org/
140140
.. _pynwb: https://pynwb.readthedocs.io/en/stable/
141141

142142
.. toctree::

0 commit comments

Comments
 (0)