Skip to content

Commit ab5d2c8

Browse files
committed
Updated ephys link exe name and instructions
1 parent e087716 commit ab5d2c8

File tree

1 file changed

+63
-44
lines changed

1 file changed

+63
-44
lines changed

source/ephys_link/installation_and_use.md

Lines changed: 63 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,25 @@
1010
<img width="100%" src="https://github.com/VirtualBrainLab/ephys-link/assets/82800265/0c7c60b1-0926-4697-a461-221554f82de1" alt="Manipulator and probe in pinpoint moving in sync">
1111

1212
The [Electrophysiology Manipulator Link](https://github.com/VirtualBrainLab/ephys-link)
13-
(or Ephys Link for short) is a Python [Socket.IO](https://socket.io/docs/v4/#what-socketio-is) server that allows any
13+
(or Ephys Link for short) is a
14+
Python [Socket.IO](https://socket.io/docs/v4/#what-socketio-is) server that
15+
allows any
1416
Socket.IO-compliant application (such
1517
as [Pinpoint](https://github.com/VirtualBrainLab/Pinpoint))
1618
to communicate with manipulators used in electrophysiology experiments.
1719

18-
**Supported Manipulator Platforms:**
20+
**Supported Manipulators:**
1921

20-
| Manufacturer | Model |
21-
|--------------|---------------------------------------------------------------------------|
22-
| Sensapex | <ul> <li>uMp-4</li> <li>uMp-3</li> </ul> |
23-
| New Scale | <ul> <li>Pathfinder MPM Control v2.8.8+</li> <li>M3-USB-3:1-EP</li> </ul> |
22+
| Manufacturer | Model |
23+
|--------------|-------------------------------------------------------------------------|
24+
| Sensapex | <ul> <li>uMp-4</li> <li>uMp-3</li> </ul> |
25+
| New Scale | <ul> <li>Pathfinder MPM Control v2.8+</li> <li>M3-USB-3:1-EP</li> </ul> |
2426

25-
Ephys Link is an open and extensible platform. It is designed to easily support integration with other manipulators.
27+
Ephys Link is an open and extensible platform. It is designed to easily support
28+
integration with other manipulators.
2629

27-
For more information regarding the server's implementation and how the code is organized, see
30+
For more information regarding the server's implementation and how the code is
31+
organized, see
2832
the [package's development documentation](https://virtualbrainlab.org/ephys_link/development.html).
2933

3034
For detailed descriptions of the server's API, see
@@ -36,9 +40,9 @@ the [API reference](https://virtualbrainlab.org/api_reference_ephys_link.html).
3640

3741
1. An **x86 Windows PC is required** to run the server.
3842
2. For Sensapex devices, the controller unit must be connected via an ethernet
39-
cable and powered. A USB-to-ethernet adapter is acceptable. For New Scale manipulators,
40-
the controller unit must be connected via USB and be powered by a 6V power
41-
supply.
43+
cable and powered. A USB-to-ethernet adapter is acceptable. For New Scale
44+
manipulators, the controller unit must be connected via USB and be powered by
45+
a 6V power supply.
4246
3. To use the emergency stop feature, ensure an Arduino with
4347
the [StopSignal](https://github.com/VirtualBrainLab/StopSignal) sketch is
4448
connected to the computer. Follow the instructions on that repo for how to
@@ -53,34 +57,24 @@ will not work with the web browser versions of Pinpoint at this time.
5357
1. Download the latest executable from
5458
the [releases page](https://github.com/VirtualBrainLab/ephys-link/releases/latest).
5559
2. Double-click the executable file to launch the configuration window.
56-
1. Take note of the IP address and port. **Copy this information into Pinpoint to connect**.
60+
1. Take note of the IP address and port. **Copy this information into
61+
Pinpoint to connect**.
5762
3. Select the desired configuration and click "Launch Server".
5863

59-
The configuration window will close and the server will launch. Your configurations will be saved for future use.
64+
The configuration window will close and the server will launch. Your
65+
configurations will be saved for future use.
6066

61-
To connect to the server from Pinpoint, provide the IP address and port. For example, if the server is running on the
67+
To connect to the server from Pinpoint, provide the IP address and port. For
68+
example, if the server is running on the
6269
same computer that Pinpoint is, use
6370

6471
- Server: `localhost`
6572
- Port: `8081`
6673

67-
If the server is running on a different (local) computer, use the IP address of that computer as shown in the startup
74+
If the server is running on a different (local) computer, use the IP address of
75+
that computer as shown in the startup
6876
window instead of `localhost`.
6977

70-
### Install for Development
71-
72-
1. Clone the repository.
73-
2. Install [Hatch](https://hatch.pypa.io/latest/install/)
74-
3. Install the latest Microsoft Visual C++ (MSVC v143+ x86/64) and the Windows SDK (10/11)
75-
via [Visual Studio Build Tools Installer](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
76-
4. In a terminal, navigate to the repository's root directory and run
77-
78-
```bash
79-
hatch shell
80-
```
81-
82-
This will create a virtual environment, install Python 12 (if not found), and install the package in editable mode.
83-
8478
### Install as a Python package
8579

8680
```bash
@@ -96,34 +90,59 @@ server = Server()
9690
server.launch("sensapex", 8081)
9791
```
9892

93+
### Install for Development
94+
95+
1. Clone the repository.
96+
2. Install [Hatch](https://hatch.pypa.io/latest/install/)
97+
3. Install the latest Microsoft Visual C++ (MSVC v143+ x86/64) and the Windows
98+
SDK (10/11)
99+
via [Visual Studio Build Tools Installer](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
100+
4. In a terminal, navigate to the repository's root directory and run
101+
102+
```bash
103+
hatch shell
104+
```
105+
106+
This will create a virtual environment, install Python 12 (if not found), and
107+
install the package in editable mode.
108+
99109
## CLI Usage
100110

101-
Ephys Link can be launched from the command line directly without the configuration window. This is useful for computers
111+
Ephys Link can be launched from the command line directly without the
112+
configuration window. This is useful for computers
102113
or servers without graphical user interfaces.
103114

104-
With the standalone executable downloaded, invoking the executable from the command line:
115+
With the standalone executable downloaded, invoking the executable from the
116+
command line:
105117

106118
```bash
107-
ephys_link-vX.X.X-Windows-x86_64.exe -b
119+
EphysLink-vX.X.X.exe -b
108120
```
109121

110-
Use the actual name of the executable you downloaded. The `-b` or `--background` flag will launch the server without the
122+
Use the actual name of the executable you downloaded. The `-b` or `--background`
123+
flag will launch the server without the
111124
configuration window and read configuration from CLI arguments.
112125

113-
Run the following commands in a terminal to start the server for the desired manipulator platform without the startup
114-
window (replace `ephys_link.exe` with the actual name of the executable you downloaded):
126+
Run the following commands in a terminal to start the server for the desired
127+
manipulator platform without the startup
128+
window (replace `EphysLink.exe` with the actual name of the executable you
129+
downloaded):
115130

116-
| Manipulator Platform | Command |
117-
|------------------------------------------|---------------------------------------------|
118-
| Sensapex uMp-4 | `ephys_link.exe -b` |
119-
| Sensapex uMp-3 | `ephys_link.exe -b -t ump3` |
120-
| New Scale Pathfinder MPM Control v2.8.8+ | `ephys_link.exe -b -t new_scale_pathfinder` |
121-
| New Scale M3-USB-3:1-EP | `ephys_link.exe -b -t new_scale` |
131+
| Manipulator Platform | Command |
132+
|------------------------------------------|--------------------------------------------|
133+
| Sensapex uMp-4 | `EphysLink.exe -b` |
134+
| Sensapex uMp-3 | `EphysLink.exe -b -t ump3` |
135+
| New Scale Pathfinder MPM Control v2.8.8+ | `EphysLink.exe -b -t new_scale_pathfinder` |
136+
| New Scale M3-USB-3:1-EP | `EphysLink.exe -b -t new_scale` |
122137

123138
More options can be viewed by running `ephys_link.exe -h`.
124139

125140
### "New Scale Pathfinder MPM Control" vs "New Scale M3-USB-3:1-EP"
126141

127-
New Scale manipulators have two methods of connection. The first method is through the Pathfinder MPM Control software (`-t new_scale_pathfinder`) and the second is via a direct hardware
128-
connection (`-t new_scale`). The first method is only available if Pathfinder is running on the same computer
129-
as Ephys Link. New Scale manipulators should be connected to the Pathfinder software first and the Pathfinder HTTP server should be running.
142+
New Scale manipulators have two methods of connection. The first method is
143+
through the Pathfinder MPM Control software (`-t new_scale_pathfinder`) and the
144+
second is via a direct hardware
145+
connection (`-t new_scale`). The first method is only available if Pathfinder is
146+
running on the same computer
147+
as Ephys Link. New Scale manipulators should be connected to the Pathfinder
148+
software first and the Pathfinder HTTP server should be running.

0 commit comments

Comments
 (0)