Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 1.6 KB

pre-commit Code style: black Python 3.6

How to contribute

Open an issue :

  1. specify in the title the implementation concerned (probe type and acquisition system)
  2. An use-case allowing to easily reproduce a bug is always appreciate

Issue are always welcome, don't hesitate to share your thought about this module.

Add a new probe type :

  1. Fork the repository and open a pull request
  2. develop a class implementation inherited from template_probe with at least the create_channel_map method which populate the arguments :
  • _yCoord = y position
  • _xCoord = x position
  • _kCoord = shank position
  • _elecInd = electrode number
  • _connected = 1 everywhere except if broken channel deactivated (0)
  • _chanMap = channel number (data acquisition indice)
  • _chanMap0ind = channel number starting from 0 instead of 1
  1. Specify the keyword use to connect with your implementation and the different options. And modify accordingly the probes init
  2. Add the documentation in your class and in the readme
  3. Add your name in the contributing list below

Improve the module

Some features idea for the future are :

  • improve the channelmap drawing
  • display specify channel in the channelmap order (?)
  • Add unity tests
  • ...

Contributors :