From ae10b92c19cb52bbddbdaef2a6353a25232e7aa7 Mon Sep 17 00:00:00 2001
From: "Marie-Eve Picard (she/her)" <77584086+me-pic@users.noreply.github.com>
Date: Thu, 13 Apr 2023 13:28:34 -0400
Subject: [PATCH 1/4] update installation guide
---
docs/installation.rst | 72 +++++++++++++++++++++++++++++++++++--------
1 file changed, 60 insertions(+), 12 deletions(-)
diff --git a/docs/installation.rst b/docs/installation.rst
index 878a750..75114d6 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -1,19 +1,67 @@
-.. _installation_setup:
+.. _installation:
-Installation and setup
-======================
+============
+Installation
+============
-.. _basic_installation:
+Requirements
+------------
-Basic installation
+``peakdet`` requires python 3.6 or above, as well as the modules:
+
+.. literalinclude:: ../setup.cfg
+ :lines: 28-30
+ :dedent: 4
+
+Linux and mac installation
+--------------------------
+The most convenient option is to use ``pip``, as it allows you to automatically download and install the package from [PyPI repository](https://pypi.org/project/peakdet/) and facilitates upgrading or uninstalling it.
+
+Install with ``pip``
+^^^^^^^^^^^^^^^^^^^^
+
+.. note::
+ The following instructions are provided assuming that python 3 is **not** your default version of python.
+ If it is, you might need to use ``pip`` instead of ``pip3``, although some OSs do adopt ``pip3`` anyway.
+ If you want to check, type ``python --version`` in a terminal.
+
+To install ``peakdet`` along with the basic required modules just run::
+
+ pip3 install phys2bids
+
+You can now proceed to check your installation and start using ``peakdet``!
+
+Check your installation!
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Through the terminal, type the command::
+
+ pip show peakdet
+
+Through python script, type the commands::
+
+ import peakdet
+ print(peakdet.__version__)
+
+If your output is: ``0.2.0rc1`` or similar, ``peakdet`` is ready to be used.
+
+Windows installation
--------------------
-This package requires Python >= 3.6. Assuming you have the correct version of
-Python installed, you can install ``peakdet`` by opening a terminal and running
-the following:
+First of all let's check you have python installed. Open a windows power shell window in **admin mode** and type::
+
+ python --version
+
+In case you don't have it, either install it by clicking on the link for the *Latest python 3 Release* `here `_ or type the command::
+
+ python
+
+It will redirect you to the windows store python install (in the creation of this tutorial the newest version of python was 3.11).
+
+.. warning::
+ ``peakdet`` supports Python 3.6 and later versions. We can't guarantee it will work if you use python 2.
-.. code-block:: bash
+Once python is installed, you can follow the instructions to install ``peakdet`` reported `above <#install-with-pip>`_
- git clone https://github.com/physiopy/peakdet.git
- cd peakdet
- python setup.py install
+.. note::
+ Remember to open a terminal in **admin mode** to install libraries!
\ No newline at end of file
From 55ba3fe7bb8d3c08ec31dbda36d500828f9d5809 Mon Sep 17 00:00:00 2001
From: "Marie-Eve Picard (she/her)" <77584086+me-pic@users.noreply.github.com>
Date: Thu, 13 Apr 2023 13:30:48 -0400
Subject: [PATCH 2/4] update installation guide
---
docs/installation.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/installation.rst b/docs/installation.rst
index 75114d6..7ab0f12 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -15,7 +15,7 @@ Requirements
Linux and mac installation
--------------------------
-The most convenient option is to use ``pip``, as it allows you to automatically download and install the package from [PyPI repository](https://pypi.org/project/peakdet/) and facilitates upgrading or uninstalling it.
+The most convenient option is to use ``pip``, as it allows you to automatically download and install the package from `PyPI repository ` and facilitates upgrading or uninstalling it.
Install with ``pip``
^^^^^^^^^^^^^^^^^^^^
From 67b2a03bac9b283363a2e6995f82da81e19ab17f Mon Sep 17 00:00:00 2001
From: "Marie-Eve Picard (she/her)" <77584086+me-pic@users.noreply.github.com>
Date: Thu, 13 Apr 2023 13:31:48 -0400
Subject: [PATCH 3/4] fix pypi hyperlink
---
docs/installation.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/installation.rst b/docs/installation.rst
index 7ab0f12..da61867 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -15,7 +15,7 @@ Requirements
Linux and mac installation
--------------------------
-The most convenient option is to use ``pip``, as it allows you to automatically download and install the package from `PyPI repository ` and facilitates upgrading or uninstalling it.
+The most convenient option is to use ``pip``, as it allows you to automatically download and install the package from `PyPI repository `_ and facilitates upgrading or uninstalling it.
Install with ``pip``
^^^^^^^^^^^^^^^^^^^^
From 91f3ec227d742f69095b8ddc763ad4ee7bc5cb3c Mon Sep 17 00:00:00 2001
From: Stefano Moia
Date: Thu, 18 Apr 2024 16:03:51 +0200
Subject: [PATCH 4/4] Update docs/installation.rst
---
docs/installation.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/installation.rst b/docs/installation.rst
index da61867..d73ea3e 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -27,7 +27,7 @@ Install with ``pip``
To install ``peakdet`` along with the basic required modules just run::
- pip3 install phys2bids
+ pip3 install peakdet
You can now proceed to check your installation and start using ``peakdet``!