[MRG + 1] ENH: try making HNN GUI with ipywidgets

.github/workflows/unit_tests.yml

@@ -36,6 +36,7 @@ jobs:
           pip install flake8 pytest pytest-cov
           pip install mne psutil joblib
           pip install NEURON
+          pip install ipywidgets voila
           if [ "${{ matrix.os }}" == "ubuntu-latest" ]; then
             pip install mpi4py
           else
@@ -56,4 +57,4 @@ jobs:
       - name: Upload code coverage
         shell: bash -el {0}
         run: |
-          bash <(curl -s https://codecov.io/bash) -f ./coverage.xml
+          bash <(curl -s https://codecov.io/bash) -f ./coverage.xml

MANIFEST.in

@@ -9,6 +9,7 @@ recursive-include hnn_core/mod/x86_64 *
 recursive-include hnn_core/mod/x86_64/.libs *
 
 recursive-include hnn_core *.py
+recursive-include hnn_core *.ipynb
 
 ### Exclude
 

README.rst

@@ -13,7 +13,11 @@ hnn-core
 	:target: https://codecov.io/gh/jonescompneurolab/hnn-core
 	:alt: Test coverage
 
-This is a leaner and cleaner version of the code based off the `HNN repository <https://github.com/jonescompneurolab/hnn>`_. However, a Graphical User Interface is not supported at the moment in this repository.
+.. image:: https://user-images.githubusercontent.com/11160442/178095018-35d2619a-6a82-4e27-91c9-ff2796fab435.png
+   :target: https://user-images.githubusercontent.com/11160442/178095018-35d2619a-6a82-4e27-91c9-ff2796fab435.png
+   :alt: HNN-core GUI
+
+This is a leaner and cleaner version of the code based off the `HNN repository <https://github.com/jonescompneurolab/hnn>`_.
 
 It is early Work in Progress. Contributors are very welcome.
 
@@ -28,6 +32,15 @@ Dependencies
 Optional dependencies
 ---------------------
 
+GUI
+~~~
+
+* ipywidgets
+* voila
+
+Parallel processing
+~~~~~~~~~~~~~~~~~~~
+
 * joblib (for simulating trials simultaneously)
 * mpi4py (for simulating the cells in parallel for a single trial). Also depends on:
 
@@ -58,6 +71,16 @@ To check if everything worked fine, you can do::
 
 and it should not give any error messages.
 
+**GUI installation**
+
+To install the GUI dependencies along with ``hnn-core``, a simple tweak to the above command is needed::
+
+   $ pip install hnn_core[gui]
+
+To start the GUI, please do::
+
+   $ hnn-gui
+
 **Parallel backends**
 
 For further instructions on installation and usage of parallel backends for using more

binder/postBuild

@@ -0,0 +1,3 @@
+set -e
+
+python setup.py build_mod

binder/requirements.txt

@@ -0,0 +1,5 @@
+NEURON
+voila
+ipywidgets
+matplotlib
+scipy