Skip to content

Commit

Permalink
MNT: Update Readme (#96)
Browse files Browse the repository at this point in the history
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
marsipu and pre-commit-ci[bot] authored Jul 2, 2024
1 parent 94a5109 commit eeb5ad8
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@

1. Install MNE-python as instructed on
the [website](https://www.martinos.org/mne/stable/install_mne_python.html)
2. Then run `pip install https://github.com/marsipu/mne-pipeline-hd/zipball/main` in the conda-enviroment you created in step 1 for MNE-Python.
2. To install `mne_pipeline_hd` in the conda-enviroment you created in step 1 you can either
- Install the stable version with `pip install mne_pipeline_hd`
- Install the development version with `pip install git+https://github.com/marsipu/mne_pipeline_hd.git@main`

## Update

Run `pip install --upgrade --no-deps --force-reinstall https://github.com/marsipu/mne-pipeline-hd/zipball/main`
Run `pip install --upgrade --no-deps --force-reinstall git+https://github.com/marsipu/mne_pipeline_hd.git@main`
for an update to the development version
or `pip install --upgrade mne-pipeline-hd` for the latest release.
or `pip install --upgrade mne-pipeline-hd` for the latest stable release.

## Start

Expand Down

0 comments on commit eeb5ad8

Please sign in to comment.