hnn-core 0.4rc0

hnn-core

Installation

We recommend the Anaconda Python distribution. To install hnn-core, simply do:

$ pip install hnn_core

and it will install hnn-core along with the dependencies which are not already installed.

Note that if you installed Neuron using the traditional installer package, it is recommended to remove it first and unset PYTHONPATH and PYTHONHOME if they were set. This is because the pip installer works better with virtual environments such as the ones provided by conda.

If you want to track the latest developments of hnn-core, you can install the current version of the code (nightly) with:

$ pip install --upgrade https://api.github.com/repos/jonescompneurolab/hnn-core/zipball/master

To check if everything worked fine, you can do:

$ python -c 'import hnn_core'

and it should not give any error messages.

Installing optimization dependencies

If you are using bayesian optimization, then scikit-learn is required. Install hnn-core with scikit-learn using the following command:

$ pip install hnn_core[opt]

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]

Note if you are zsh in macOS the command is:

$ 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 than one CPU core, refer to our parallel backend guide.

Note for Windows users

Install Neuron using the precompiled installers before installing hnn-core. Make sure that:

$ python -c 'import neuron;'

does not throw any errors before running the install command. If you encounter errors, please get help from NEURON forum. Finally, do:

$ pip install hnn_core[gui]

Documentation and examples

Once you have tested that hnn_core and its dependencies were installed, we recommend downloading and executing the example scripts provided on the documentation pages (as well as in the GitHub repository).

Note that python plots are by default non-interactive (blocking): each plot must thus be closed before the code execution continues. We recommend using and ‘interactive’ python interpreter such as ipython:

$ ipython --matplotlib

and executing the scripts using the %run-magic:

%run plot_simulate_evoked.py

When executed in this manner, the scripts will execute entirely, after which all plots will be shown. For an even more interactive experience, in which you execute code and interrogate plots in sequential blocks, we recommend editors such as VS Code and Spyder.

Bug reports

Use the github issue tracker to report bugs. For user questions and scientific discussions, please see our GitHub Discussions page.

Interested in Contributing?

Read our contributing guide.

Governance Structure

Read our governance structure.

Citing

If you use HNN-core in your work, please cite our publication in JOSS:

Jas et al., (2023). HNN-core: A Python software for cellular and circuit-level interpretation of human MEG/EEG. Journal of Open Source Software, 8(92), 5848, https://doi.org/10.21105/joss.05848