|
|
@@ -1,3 +1,41 @@
|
|
|
-# ephy_testing_data
|
|
|
+# Electrophysiology Testing Data
|
|
|
|
|
|
-Collection of testing data in various electrophysiology file formats.
|
|
|
+Collection of testing data in various electrophysiology file formats. The datasets in this repository are used within the [Neo](https://github.com/NeuralEnsemble/python-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 dataset 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](https://gin.g-node.org) platform**
|
|
|
+- Create a [gin account](https://gin.g-node.org/user/sign_up)
|
|
|
+- Open an issue stating the format of files you would like to add. Please specify in this issue, which type of system is generating these files and in which software your files could be used as testing files. After reviewing the proposed format you will be added as a collaborator to the project.
|
|
|
+
|
|
|
+**On your local computer**
|
|
|
+- Install the gin client on your machine ([gin-cli setup instructions](https://gin.g-node.org/G-Node/Info/wiki/GIN+CLI+Setup))
|
|
|
+- Log in with your gin-cli (`gin login`)
|
|
|
+- Create a local copy of the repository on your machine (`gin get NeuralEnsemble/ephy_testing_data`)
|
|
|
+- Create a new git branch to work on via `gin git checkout -b <my_branch_name>`
|
|
|
+- Create a new subfolder with the corresponding system brand name or identify the folder to which to add your files.
|
|
|
+- Copy your files in the new folder. Feel free to add an attribution to it, e.g. see [this readme](https://gin.g-node.org/NeuralEnsemble/ephy_testing_data/src/master/neuralynx/Cheetah_v5.5.1/README.txt).
|
|
|
+- Commit your files via `gin commit <folder_name>`
|
|
|
+- Lock the files via `gin lock *`
|
|
|
+- Upload your changes to gin via `gin upload`
|
|
|
+
|
|
|
+**On the [gin](https://gin.g-node.org) platform**
|
|
|
+- The new branch `<my_branch_name>` should be available at the [webpage](https://gin.g-node.org/NeuralEnsemble/ephy_testing_data). Verify that the changes are correctly registered in this branch.
|
|
|
+- Open a pull request (PR) with your changes to the master branch of the `NeuralEnsemble/ephy_testing_data` repository. In your PR description please specify again what format you want to add, which type of system is generating these files and which software could make use of these.
|
|
|
+- 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: Don't forget to switch back to the master branch after completion of your PR: `gin git checkout master`
|
