Contributions:Contents: Difference between revisions
No edit summary |
No edit summary |
||
| Line 8: | Line 8: | ||
*[[Contributions:Applications]]: Application modules, and interoperability with other software. | *[[Contributions:Applications]]: Application modules, and interoperability with other software. | ||
*[[Contributions:Tools]]: Data analysis tools. | *[[Contributions:Tools]]: Data analysis tools. | ||
==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 [[Programming Howto:Building BCI2000#Building Contributions|Building BCI2000 Howto Page]] on how to do this. | |||
==How to contribute== | ==How to contribute== | ||
| Line 14: | Line 17: | ||
A contribution consists of two parts: | A contribution consists of two parts: | ||
*A directory in the source repository. | *A directory in the source repository. | ||
:After contacting an [[Administrator]], a directory will be created for your project in the SVN source code 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 [[Programming Reference:Cpp Coding Style|C++ coding style]] page. | ||
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 [[Programming Reference:Cpp Coding Style|C++ coding style]] page. | |||
*A wiki page in the contributions section. | *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. | :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. | ||
Revision as of 20:53, 6 November 2007
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.
Available code in the Contribution section
- Contributions:ADCs: Data acquisition modules for various ADC cards and EEG amplifiers.
- Contributions:FileWriters: Additional file formats.
- Contributions:SignalProcessing: Signal processing filters.
- Contributions:Applications: Application modules, and interoperability with other software.
- Contributions:Tools: Data analysis tools.
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 more than 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.