ephy_testing_data/README.md

Electrophysiology Testing Data

Collection of testing data in various electrophysiology file formats. The datasets in this repository are used within the Neo project.

Contributing

If you have small data files in a format used in electrophysiology and you want to make these files publicly available for the purpose of software building on that format, then this is the right place to contribute!

Requirements

To contribute a data set the following criteria need to be fulfilled

• You need to have the rights to publish the data files
• The data files need to be small in size (ideally in the range of kilobytes, no more than 10MB)

How to add files

You can suggest to add your files via a pull request by following the steps below

On the gin platform

• Create a gin account
• Fork the NeuralEnsemble/ephy_testing_data repository to your gin account using the 'fork' in the webinterface

On your local computer

• Install the gin client on your machine (gin-cli setup instructions)
• Create a local copy of your fork on your machine (gin get <account_name>/<repository_name>)
• Create a new git branch to work on via git checkout -b <my_branch_name>
• Create a new subfolder with the corresponding brand name / extend an existing folder for a format
• Copy your files in the new folder. Feel free to add an attribution to it, e.g. see this readme.
• Upload your changes to your fork via gin upload <folder_name>

On the gin platform

• The new branch <by_branch_name> should be available in your fork. Verify that the changes are correctly registered in this branch.
• Open a pull request (PR) with your changes to the NeuralEnsemble/ephy_testing_data repository. In your PR description please specify what format you want to add, which type of system is generating these files and in which software your files could be used as testing files.
• You will potentially receive comments from the repository maintainers asking you to change some details in your PR.
• After resolving the comments your files will be merged into the main repository.

Congratulation! Your files are now part of the growing collection of electrophysiology testing files and can now be used by any project to check for file format compatibility.

Note: This workflow currently only works for small files, as this does not require the movement of git-annexed content from one repository to another.