Merge pull request #75 from Remi-Gau/remi-notebooks

notebook and binder

Author: Remi-Gau

.gitignore

@@ -21,6 +21,9 @@ tests/*.tsv*
 # exclude report from check_my_code
 check_my_code_report.txt
 
+# jupyter notebook checkpoints
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
 
 
 

README.md

@@ -56,6 +56,7 @@ sub-090/ses-003/sub-090_ses-003_task-auditoryTask_run-023_events_date-2020072915
 
 - [Installation](./docs/installation.md)
 - [How to use it](./docs/usage.md)
+- [Jupyter notebooks](./notebooks/README.md)
 - [Functions description](./docs/functions_description.md)
 
 ##  3. <a name='Contributing'></a>Contributing

binder/apt.txt

@@ -0,0 +1,2 @@
+octave
+liboctave-dev

binder/environment.yml

@@ -0,0 +1,2 @@
+dependencies:
+- octave_kernel

binder/postBuild

@@ -0,0 +1,4 @@
+cd ${HOME}
+cd lib/JSONio; mkoctfile --mex jsonread.c jsmn.c -DJSMN_PARENT_LINKS; cd ..
+sudo apt-get install tree
+

notebooks/README.md

@@ -0,0 +1,11 @@
+# README
+
+1. Make sure that you have Octave installed. 
+2. If you have Conda/Jupyter/pip installed, go to step 4.
+3. Download the [Anaconda Installer](https://www.anaconda.com/products/individual) and install it.
+4. Install [Octave kernel](https://pypi.org/project/octave-kernel/): 
+   ```
+   pip install octave_kernel
+   ```
+5. Run `jupyter notebook` in your terminal. `Octave` should appear on the list
+   for creating a new notebook.