Update doc and examples

MattNolanLab · Mar 11, 2021 · ee2315e · ee2315e
1 parent 6d0d652
commit ee2315e
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -11,13 +11,17 @@ Allow one to write data into open-ephys continuous and binary format. Useful for
 - Basically allow one to convert any neuron data readable in python to open-ephys format
 
 
+### Installation
+
+- clone the repository `git clone https://github.com/teristam/openephys-fileIO.git`
+- go to the `openephys-fileIO` folder, then `pip install .`
 
 ### Usage
 
 Fast load a continuous file:
 
 ```
-import fileIO
+from openephys_fileIO import fileIO
 file = fileIO.loadContinuousFast('test/data/100_CH1.continuous')
 ```
 

diff --git a/example_WriteBinary.py b/example_WriteBinary.py
@@ -5,7 +5,7 @@
 
 import numpy as np 
 from pathlib import Path
-from openephys_fileIO import  fileIO
+from openephys_fileIO import fileIO
 
 #%% Convert continuous data to flat binary
 outFolder = 'E:\\open-ephys-testdata\\M2_D23-binary'

diff --git a/example_shortenRecordings.py b/example_shortenRecordings.py
@@ -1,5 +1,5 @@
 #%%
-import fileIO
+from openephys_fileIO import fileIO
 import numpy as np
 import os
 import shutil