Jump to content

Contributions:Contents: Difference between revisions

From BCI2000 Wiki
Mellinger (talk | contribs)
Mellinger (talk | contribs)
Line 3: Line 3:


==Code available in the Contribution section==
==Code available in the Contribution section==
*[[Contributions:ADCs]]: Data acquisition modules for various ADC cards and EEG amplifiers.
*[[Contributions:ADCs]]: Data acquisition modules for various ADC boards and EEG amplifiers.
*[[Contributions:FileWriters]]: Additional file formats.
*[[Contributions:FileWriters]]: Additional file formats.
*[[Contributions:SignalProcessing]]: Signal processing filters.
*[[Contributions:SignalProcessing]]: Signal processing filters.

Revision as of 12:38, 16 April 2008

In the contribution section, we hold code that has either been part of the distribution previously, or that is contributed by users of BCI2000. While we try to keep contributed code functional, we cannot apply the same standards in maintenance and testing as we do for the code that constitutes the "core" BCI2000 distribution.

Code available in the Contribution section

How to use contributions

In the core distribution, there are no contributions included. You will need to build executables from contributed code before you can use them. See the Building BCI2000 Howto Page on how to do this.

How to contribute

When you have developed your own data acquisition module, signal processing algorithm, application module, or analysis tool for use with BCI2000, and feel that others might profit from using it in their own experiments, then you are welcome to add it to our code database.

A contribution consists of two parts:

  • A directory in the source repository.
After contacting an Administrator, a directory will be created for your project in the SVN source code repository. You will have write access to that directory, so you can always update your code to fix bugs, or add functionality. When submitting C++ code, we also ask you to check our C++ coding style page.
  • A wiki page in the contributions section.
On the wiki page, you should give a short description of your code, i.e., an overview of its functionality, documentation of its parameters, and additional information that the user needs to know in order to use it. It should also be clear for which version (source code revision) your code was developed, and which it was last tested with. We provide a Contributions:Contribution Wiki Template page as a starting point.

Licensing Issues

  • Please, do not upload copyrighted material to the contributions section without the copyright holder's consent. When in doubt, provide a link to its original location rather than a copy.
  • When your code relies on libraries that are released under the GNU General Public License (GPL), this automatically implies that your contribution must be released under the GPL as well. Although BCI2000 itself is not released under the GPL, your contribution may still be, similarly to the way a Windows-based program may be released under the GPL although it requires Microsoft's headers to compile, and Microsoft's OS to run.