Difference between revisions of "AnyWave:Faq"

From WikiMEG
Jump to: navigation, search
(Linux)
(What is a plug-in?)
Line 35: Line 35:
 
=Plug-ins=
 
=Plug-ins=
 
==What is a plug-in?==
 
==What is a plug-in?==
'''AnyWave''' is using the '''Qt''''s mechanism for plug-ins embedded in a shared library.<br/>
+
'''AnyWave''' is using the external modules, called plug-ins, that are loaded at startup.<br/>
Depending on the platform '''AnyWave''' is running in, plug-ins could be '''DLL''' files, '''.so''' files or '''.dylib''' files.
+
Depending on the platform, plug-ins are files of different types.<br/>
On '''Windows''' and '''Linux''', the default plug-ins are located in a folder called '''Plugins''' located in the application folder.
+
 
On '''Mac''' Sytems, the folder is called '''Anywave_Plugins''' and is located in the '''Applications''' directory.
+
On '''Windows''', for example, plug-ins are DLL files located in the '''Plugins''' folder where '''AnyWave''' is installed.<br/>
 +
Note that it is also possible to install plug-ins the user's home directory. See how to install plug-ins.<br/>
 +
 
 +
There are several types of plug-ins used by '''AnyWave''':<br/>
 +
- Reader plug-ins are responsible of reading data file formats.<br/>
 +
- Writer plug-ins are responsible of writing data to a data file format.<br/>
 +
- Signal processing plug-ins will run some processing on data and present or not results in '''AnyWave'''.<br/>
 +
- Display plug-ins are responsible of displaying specific data type. Typically, the results computed by Signal processing plug-ins.<br/>
  
 
==How can I install or remove a plug-in?==
 
==How can I install or remove a plug-in?==

Revision as of 20:49, 17 February 2014

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.

Donwloading AnyWave

Click on the links below to download AnyWave for your platform:

How to install AnyWave

Windows

The 32bit version of AnyWave will run on all Windows versions starting with Windows XP.
However, on 64bit Windows systems, it will run as a 32bit application. Therefore, AnyWave won't take advantage of all the memory installed on the system.
Please install the 64bit version of AnyWave on a 64bit Windows.
The 64bit version of AnyWave will run on Windows Vista x64, Windows 7 x64 and Windows 8 x64.

Download the zip file, uncompress it in a temporary folder then launch the isntaller. You must have administrative's privileges in order to install the software.

Mac OS X

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

Be sure to have Qt 4.7.x installed on your Mac. If not, download and install Qt before trying to install AnyWave.
Donwload the zip file, uncompress it on a temporary folder then open the package installer and follow instructions.
You might need to install additionnal software in order to get access to some features of AnyWave. See below.

AnyWave will send notifications messages during some operations. To see that 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 Linux.

Download the package and install it on your system using a terminal or by double clicking on the file.

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

Plug-ins

What is a plug-in?

AnyWave is using the external modules, called plug-ins, that are loaded at startup.
Depending on the platform, plug-ins are files of different types.

On Windows, for example, plug-ins are DLL files located in the Plugins folder where AnyWave is installed.
Note that it is also possible to install plug-ins the user's home directory. See how to install plug-ins.

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 results in AnyWave.
- Display plug-ins are responsible of displaying specific data type. Typically, the results computed by Signal processing plug-ins.

How can I install or remove a plug-in?

To remove a plug-in, simply delete the corresponding file(s) located in the Plugins sub folder. Beware to quit AnyWave before doing that.

Adding plug-ins consist in copying files in the Plugins (or Anywave_Plugins) folder. That operation may require administrative privileges and will set the plug-ins available to everyone that could use the computer.

To install user plug-ins, locate the AnyWave folder created in the user's home directory. There is a sub-folder called Plugins located in that directory. Place user plug-ins in it.

Launch AnyWave and verify that the plug'ins were successfully loaded by clicking on the View menu and choose plugins.

Can I develop my own plug-ins?

Yes, if you are a C++ developper knowing Qt's framework. Some plug-ins can be develop using Matlab or Python though.
Check out the appendice to have a complete documentation about how to do that.