Installing from sources

This page covers installing EEGDash from source, which is what you want for contributing or for trying features that have not yet been released.

For an overview of contributor workflows and project internals, see Developer Notes.

Note

If you only want to install a released version, see Installing from PyPI.

Install a pre-release from PyPI

pip install --pre eegdash

This installs the in-development version of eegdash from the main branch. It may not be stable.

Install directly from GitHub

Clone the repository and change into it:

git clone https://github.com/eegdash/EEGDash && cd EEGDash

Install with pip

For a one-off install straight from GitHub:

pip install git+https://github.com/eegdash/EEGDash.git

From a local clone, install in editable mode so source edits are picked up without reinstalling:

pip install -e .

Optional extras let you pull in test and documentation dependencies:

pip install -e .[test,docs,dev]

Or install everything, which is what you want for contributing:

pip install -e .[all]

Verifying the installation

python -c "import eegdash; print(eegdash.__version__)"