README.md 4.25 KB
Newer Older
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
1
2
# Introduction

3
FPulse is a program for patch-clamp recordings. The experimental protocols can defined through its own scripting language. A number of example scripts are are available in [FPulse Example Scripts](https://git.ist.ac.at/jonasgroup/FPulse/-/tree/master/UserIgor/FPulse/SomeDemoScripts). FPulse uses MultiClamp amplifier(s), and CED1401 data acquistion systems, and is running in top of IgorPro from Wavemetrics.
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
4

5
If not stated otherwise, all copyrights are with:
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
6
7

```
8
  Copyright (C) 2001-2021 Ulrich Fröbe, University of Freiburg, Germany
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
9
10
11
12
  Copyright (C) 2001-2010 Peter Jonas, University of Freiburg, Germany
  Copyright (C) 2011-2021 Peter Jonas, Institute of Science and Technology, Austria
```

13
This code is provided under the GPLv3 license (see COPYING). The GPL license does not apply to these files:
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
14

15
16
17
18
19
20
```
	.\UserIgor\XOP_Axon\FP_Mc700Tg\MultiClampBroadcastMsg.hpp
	.\UserIgor\XOP_Axon\FP_Mc700Tg\MCTelegraphs.h
	.\UserIgor\XOP_Dll\AxMultiClampMsg.dll
```

21
22
These files can be also obtained by installing [Installer of MC700B](http://axograph.com/installers/MultiClamp_2_1_0_16.exe). These files are then located at (C:\Program Files (x86)\Molecular Devices\MultiClamp 700B Commander).

23
This repository is setup mainly for documentation purpose, no active development or support is provided.
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
24
25


26
## Installing FPulse
27
* Prerequisites are
28
29
	- MS Windows (7 or later)
	- IgorPro 6.20+
30
	- MultiClamp 700A or 700B  or  Axopatch 200A or 200B
31
	- CED 1401
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
32

33
34
35
36
37
38
* Download and unzip [FPulse v3.45 (stable)](https://git.ist.ac.at/jonasgroup/FPulse/-/archive/v3.45/FPulse-v3.45.zip). This is recommended for production use, i.e. when you want to use FPulse for your data recordings.

* If you want to test and tweak FPulse, use the latest development version which is available from here:
[FPulse (latest)](https://git.ist.ac.at/jonasgroup/FPulse/-/archive/master/FPulse-master.zip)

* or use git
39
40
41

```
   git clone https://git.ist.ac.at/jonasgroup/FPulse
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
42
```
43

Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
44
If you have an old version of FPulse installed, it is strongly recommended to uninstall it. (e.g. the uninstaller of 3.3.3 can be found on C:\UserIgor\FPulse or C:\FPulse ).
45
46
47

* The recommended way to install FPulse is by opening a CMD prompt with admin permission ("Run as administrator) and running

Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
48
```
49
50
   install.bat
```
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
51
FPulse will be installed in C:\UserIgor\FPulse, which contains also the ```uninstall.bat``` script (it needs also admin permissions).
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
52

53
54

* Fpulse example scripts for controlling the experiment will be available under
55
56

```
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
57
   C:\UserIgor\FPulse\SomeDemoScripts\
58
```
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
59

60

61
## Build requirements
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
62

63
### Igor XOP toolkit
64

65
[XOP toolkit 6](https://www.wavemetrics.com/products/xoptoolkit "XOP toolkit 6") has been used for the interface been C-code and IgorPro.
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
66

67
[1]: https://www.wavemetrics.com/products/xoptoolkit "XOP toolkit"
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
68

69

70
### Compiler
71
   MSVC2015 is known to work. Other compilers have not been tested.
72

73

74
Open these two sln files:
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
75
76

```
77
78
79
  ./UserIgor/XOP_Axon/FP_Mc700Tg/VC2015/FP_Mc700Tg.sln
  ./UserIgor/XOP_Ced/FPulseCed/VC2015/FPulseCed.sln
```
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
80

81
The solution file assumes that the directories are organized in the following way
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
82

83
84
85
86
87
88
```
   <mydir>/FPulse/...
   <mydir>/XOP Toolkit 6/IgorXOPs6/XOPSupport/
```

If that is not the case, you need adapt the include path such that it points to your
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
89
90

```
91
   <yourdir>/XOP Toolkit 6/IgorXOPs6/XOPSupport/
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
92
93
94
```


95
According to [this documentation](https://docs.microsoft.com/en-us/cpp/build/reference/i-additional-include-directories?view=msvc-160), you need to set this compiler option in the Visual Studio development environment:
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
96

97
- Open the project's Property Pages dialog box. For details, see Set C++ compiler and build properties in Visual Studio.
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
98

99
- Select the Configuration Properties > C/C++ > General property page.
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
100

101
- Modify the Additional Include Directories property and add 
102
```
103
   <yourdir>\XOP Toolkit 6\IgorXOPs6\XOPSupport\
104
```
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
105

106
107
You might also need to adapt the path in the "*.rc" files. (When you rebuild the project, the compiler will point you to the line). 

108

109
110
# Contact
In case of questions concerning FPulse, you can contact any of these: 
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
111

112
113
114
  Peter Jonas <peter.jonas@ist.ac.at>,
  Ulrich Fröbe <ulfroebe@gmail.com>,
  Alois Schlögl <alois.schloegl@ist.ac.at>
Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
115
116


117
118
119
120
121
# Related tools:
* [Biosig](https://biosig.sourceforge.io/)
* [StimFit](http://stimfit.org)
* [SigViewer](https://github.com/cbrnr/sigviewer)

Alois SCHLOEGL's avatar
Alois SCHLOEGL committed
122
123