Revision as of 18:49, 24 February 2015

Frequently asked questions (FAQ) about AnyWave. If you don't have an answer to your question reading the Documentation, you may find useful information here.

Donwload AnyWave

Click on the link below to download AnyWave for your platform:
Download AnyWave

The current available versions are:

• Windows 32bit - Feb 2015 (ATTENTION: no MATLAB/Python support)
• Windows 64bit - Feb 2015 (with Python script support)
• Mac OS X - Feb 2015 (with Python script support)
• Linux amd64 Debian - Feb 2015 (with Python script support) - The package is also compatible with Ubuntu 14.04 and earlier versions.

Do not hesitate to signal installation problems or other issues using our BUG TRACKER

Documentation

The user guide is alvailable here.

See alse specific Wiki parts dedicated to plug-ins development.

Develop a MATLAB plug-in

Develop a Python plug-in

How to install AnyWave

Windows

There are two versions available: one for 32bit systems and one for 64bit systems.
However, the 32bit version won't be supported in the future as we are going to focus on 64bit systems.

The 32bit version does not include the MATLAB and Python support. It will be impossible to run MATLAB or Python plug-ins with this version.

After downloading the zip file, simply unzip it in a temporary folder and launch setup.exe

Mac OS X

The Mac OS X version of AnyWave supports Mac OS 10.5 to 10.10.

Donwload the zip file, uncompress it on a temporary folder then launch the AnyWave application.

There is no need to copy the Application to the Applications folder but you may do so: remember to copy the Anywave_Plugins folder as well otherwise AnyWave won't find any plugins at startup.

AnyWave will send notifications messages during some operations. To see those messages you will need to install Growl.

Linux

AnyWave is available as a Debian package for the amd64 architecture. The package should install as well on Ubuntu 64bit.

Download the package and install it on your system using dpkg -i mypackage.deb in a terminal or by double clicking on the file.

Once all the required dependencies have been installed, AnyWave will be available using the anywave command from a terminal.

Plug-ins

What is a plug-in?

AnyWave uses external modules called plug-ins, that are loaded at startup and extend the functionalities of the application.
Depending on the platform, plug-ins are files with different extensions.
On Windows systems plug-ins are .dll files where on Mac OS X systems the extension is .dylib. Linux version of AnyWave will use plugin with .so extension.

There are several types of plug-ins used by AnyWave:
- Reader plug-ins are responsible of reading data file formats.
- Writer plug-ins are responsible of writing data to a data file format.
- Signal processing plug-ins will run some processing on data and present or not the results in AnyWave.
- Display plug-ins are responsible of displaying specific data type. Typically, the results computed by signal processing plug-ins.

How to install a plug-in

When installing AnyWave, some plug-ins are also installed, allowing to read file formats or making some basic processings on data.
Those plug-ins are put in a folder where AnyWave is installed.
Depending on the platform, the path where AnyWave resides can change and the name of the plug-ins directory too.

On Windows, the user can choose where to install AnyWave. For example, AnyWave can be installed on C:\AnyWave.
If you look at C:\AnyWave you will notice the presence of a directory called Plugins. This is the location where to put plug-ins.
Note that the operation may require administrative privileges.

On Mac OS X, AnyWave will be installed where all applications go, the /Applications folder.
Besides the AnyWave application, there will be a directory named Anywave_Plugins. This is the place to put new plug-ins for AnyWave.
Note that the operation requires administrative privileges.

How to install user plug-ins

If the user has no administrative privileges and cannot install new plug-ins where AnyWave is installed, the solution is to put plug-ins in the user's home directory.

The first time AnyWave starts, it creates a folder in the user's home directory. (On Windows systems that directory is the well known "My Documents" folder.)
The place where to put user plug-ins will then be: /user's home dir/AnyWave/Plugins

Installing plug-ins in that location will allow AnyWave to use them without requiring administrative privileges.
More over, it allows installation of plug-ins that will only be available to the user.

MATLAB plug-in

AnyWave offers the possibility to run signal processing plug-ins which was written in MATLAB programming language.
There are two ways to run MATLAB code as plug-ins. You may have a MATLAB Compiled plug-in and put it in either the application's plugins folder or your own plugin directory.

MATLAB Compiled Plugin

A MATLAB Compiled plugin is most likely a classic C++ plug-in.
The difference is that the MATLAB code will run through the use of the MATLAB Compiler Runtime.
Therefore, AnyWave won't be able to load and use MATLAB Compiled Plug-ins until the MATLAB Compiler Runtime (MCR) is installed on the computer.
That is the only requirement in order for AnyWave to run MATLAB Compiled Plug-ins:
Please install the Compiler Runtime 2012b on your computer.

ATTENTION: the required version is 2012b as AnyWave was designed to use that specific version of the runtime.

Once the MATLAB Compiler Runtime is installed, AnyWave should detect it automatically (if the default installation parameters were used), and MATLAB Compiled Plug-ins will then be available.

Note: The MCR needs to be installed once and for all. You should not have two different versions of the MCR on the same computer. Please uninstall other versions than 2012b.

A MATLAB Compiled plug-in looks like a classic plug-in except that it is composed of two files: the AnyWave plug-in and the MATLAB Compiled code.
Both files have the same extension (.dll, .so or .dylib) and can be placed in the plugins folder.

MATLAB is not needed when AnyWave uses a MATLAB Compiled plug-in.

MATLAB Scripted Plugin

If you are a mighty MATLAB programmer and thus have MATLAB installed on your computer, you may use and develop a MATLAB Scripted plugin.
A MATLAB Scripted plugin is a MATLAB function that will be called by AnyWave.
It is possible to use a MATLAB Scripted plugin written by someone else just by installing it in AnyWave.

How to install a MATLAB Scripted Plugin

AnyWave provides a specific location where to put MATLAB Scripted plug-ins:
You may use the global plugin directory or the user's plugin directory. On both locations you will find a subfolder called MATLAB.
AnyWave will look for MATLAB Scripted plug-ins in the two locations. (AnyWave Application directory/Plugins/Matlab or /user's home/AnyWave/Plugins/Matlab)

A MATLAB Scripted plug-in is a simple folder containing files. If you want more details about MATLAB Scripted plug-ins, please refer to the How to write a MATLAB Scripted plug-in.

To summarize:
MATLAB Scripted plug-ins have to go in:Application dir/Plugins/Matlab or /user's home/AnyWave/Plugins/Matlab

Python plug-ins

AnyWave offers the possibility to write signal processing plug-in in Python.
Python 2.7 and all the scientific packages are included in AnyWave (starting with May 2014 versions).

A Python plug-in is very similar to a MATLAB Scripted Plug-in. The install procedure is the same except that you have to copy the plugin in a folder named Python:

Python plug-ins have to go in:AnyWave application/Plugins/Python/ or /user's home/AnyWave/Plugins/Python

File formats

AnyWave can read and/or write to different file formats depending on the available plug-ins.

For EEG data the following formats are supported for reading:

• Neuroscan (.cnt)
• Micromed (.trc)
• Electrode Array (.eab)
• EDF/BDF (.eeg)
• Brainvision Analyser (.vhdr)
• ADES (.ades) AnyWave simple format.

For MEG data the following formats are supported for reading:

• 4DNI
• CTF
• ADES (.ades) AnyWave simple format.

It is also possible to export to the following formats:

• Brainvision Analyser (.vhdr)
• ADES (.ades) AnyWave simple format.

ADES format

This is a simple file format used mostly to exchange data between different software. This is NOT the official AnyWave format but just a media used for exchanging between software.

Here is a complete documentation of the ADES file format