From 5a26c28716ad725476eef9f5c21774e92a8dd631 Mon Sep 17 00:00:00 2001 From: Adam Li Date: Tue, 10 May 2022 15:17:00 -0400 Subject: [PATCH 1/4] Fix installation instructions --- .gitignore | 2 +- doc/install.rst | 14 +++++--------- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index dd0e8599..edb02525 100644 --- a/.gitignore +++ b/.gitignore @@ -73,7 +73,7 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ +doc/_build/ # PyBuilder target/ diff --git a/doc/install.rst b/doc/install.rst index a16c7749..9b74ae14 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -12,8 +12,8 @@ Dependencies * ``torch`` (for running pytorch neural networks) We require that you use Python 3.7 or higher. -You may choose to install ``mne-icalabel`` `via pip <#Installation via pip>`_, -or conda. +You may choose to install ``mne-icalabel`` `via conda <#Installation via conda>`_, +or Pip. Installation via Conda ---------------------- @@ -38,13 +38,13 @@ simply run the following at the root of the repository: .. code-block:: bash python -m venv .venv - pip install -U mne-icalabel + pip install mne-icalabel If you want to install a snapshot of the current development version, run: .. code-block:: bash - pip install --user -U https://api.github.com/repos/mne-tools/mne-icalabel/zipball/main + pip install https://api.github.com/repos/mne-tools/mne-icalabel/zipball/main To check if everything worked fine, the following command should not give any error messages: @@ -54,8 +54,4 @@ error messages: python -c 'import mne_icalabel' mne-icalabel works best with the latest stable release of MNE-Python. To ensure -MNE-Python is up-to-date, run: - -.. code-block:: bash - - pip install --user -U mne +MNE-Python is up-to-date, see their `installation instructions _`. From 0b2483da5f1a30057dbffed601bb88206742821d Mon Sep 17 00:00:00 2001 From: Adam Li Date: Tue, 10 May 2022 15:23:26 -0400 Subject: [PATCH 2/4] Point users to installer --- doc/install.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index 9b74ae14..d44e2457 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -15,6 +15,10 @@ We require that you use Python 3.7 or higher. You may choose to install ``mne-icalabel`` `via conda <#Installation via conda>`_, or Pip. +mne-icalabel works best with the latest stable release of MNE-Python. To ensure +MNE-Python is up-to-date, see their `installation instructions _`. + + Installation via Conda ---------------------- @@ -53,5 +57,7 @@ error messages: python -c 'import mne_icalabel' -mne-icalabel works best with the latest stable release of MNE-Python. To ensure -MNE-Python is up-to-date, see their `installation instructions _`. +Installation via MNE-Installer +------------------------------ +Since MNE v1.0, there is now a standalone MNE installer, which can also optionally install +MNE-ICALabel! See `MNE page _` for more information. \ No newline at end of file From 4a8c7f2b7b5625c747011dfe866088dae68d760f Mon Sep 17 00:00:00 2001 From: Adam Li Date: Tue, 10 May 2022 15:57:57 -0400 Subject: [PATCH 3/4] Fix links --- README.md | 4 ++-- doc/install.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c01391f3..46e4efa2 100644 --- a/README.md +++ b/README.md @@ -50,10 +50,10 @@ To get the latest code using [git](https://git-scm.com/), open a terminal and ty or one can install directly using pip - pip install --user -U https://api.github.com/repos/mne-tools/mne-icalabel/zipball/main + pip install https://api.github.com/repos/mne-tools/mne-icalabel/zipball/main Alternatively, you can also download a -`zip file of the latest development version `_. +[zip file of the latest development version](https://github.com/mne-tools/mne-icalabel/archive/main.zip). # Contributing diff --git a/doc/install.rst b/doc/install.rst index d44e2457..fdf74dc5 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -16,7 +16,7 @@ You may choose to install ``mne-icalabel`` `via conda <#Installation via conda>` or Pip. mne-icalabel works best with the latest stable release of MNE-Python. To ensure -MNE-Python is up-to-date, see their `installation instructions _`. +MNE-Python is up-to-date, see their `installation instructions `_. Installation via Conda @@ -60,4 +60,4 @@ error messages: Installation via MNE-Installer ------------------------------ Since MNE v1.0, there is now a standalone MNE installer, which can also optionally install -MNE-ICALabel! See `MNE page _` for more information. \ No newline at end of file +MNE-ICALabel! See `MNE page `_ for more information. \ No newline at end of file From e7e092e3c92c4ba69315ebd49060675158695dd6 Mon Sep 17 00:00:00 2001 From: Adam Li Date: Tue, 10 May 2022 16:00:33 -0400 Subject: [PATCH 4/4] Try again --- doc/install.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/install.rst b/doc/install.rst index fdf74dc5..4da81af8 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -41,6 +41,7 @@ simply run the following at the root of the repository: .. code-block:: bash + # with python>=3.7 at least python -m venv .venv pip install mne-icalabel