Merge pull request #70 from schmidtfa/minor_fixes

Improve docs

README.md

@@ -1,6 +1,6 @@
 # PyRASA - Spectral parameterization in python based on IRASA
 
-[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![License](https://img.shields.io/badge/License-BSD_2--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)
 [![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Coverage Status](https://coveralls.io/repos/github/schmidtfa/pyrasa/badge.svg?branch=main)](https://coveralls.io/github/schmidtfa/pyrasa?branch=main)

doc/source/examples/irasa_mne.ipynb

@@ -17,23 +17,15 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import sys\n",
     "from neurodsp.sim import sim_combined\n",
     "import numpy as np\n",
     "import scipy.signal as dsp\n",
     "import matplotlib.pyplot as plt\n",
     "\n",
     "import pandas as pd\n",
     "\n",
-    "sys.path.append('../')\n",
     "import seaborn as sns\n",
     "\n",
-    "import matplotlib as mpl\n",
-    "new_rc_params = {'text.usetex': False,\n",
-    "                 \"svg.fonttype\": 'none'\n",
-    "}\n",
-    "mpl.rcParams.update(new_rc_params)\n",
-    "\n",
     "import mne\n",
     "from mne.datasets import sample\n",
     "\n",

doc/source/examples/irasa_sprint.ipynb

@@ -16,7 +16,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import sys\n",
+    "\n",
     "from neurodsp.sim import set_random_seed\n",
     "from neurodsp.sim import sim_powerlaw, sim_oscillation\n",
     "from neurodsp.utils import create_times\n",
@@ -28,12 +28,6 @@
     "#import seaborn as sns\n",
     "import pandas as pd\n",
     "\n",
-    "import matplotlib as mpl\n",
-    "new_rc_params = {'text.usetex': False,\n",
-    "                 \"svg.fonttype\": 'none'\n",
-    "}\n",
-    "mpl.rcParams.update(new_rc_params)\n",
-    "\n",
     "set_random_seed(84)\n",
     "\n",
     "from pyrasa.irasa import irasa_sprint"
@@ -330,7 +324,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "default",
    "language": "python",
    "name": "python3"
   },

doc/source/index.rst

@@ -1,9 +1,9 @@
 PyRASA - Spectral parameterization in python based on IRASA
 ===========================================================
 
-.. image:: https://www.repostatus.org/badges/latest/wip.svg
-   :target: https://www.repostatus.org/#wip
-   :alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.
+.. image:: https://www.repostatus.org/badges/latest/active.svg
+   :target: https://www.repostatus.org/#active
+   :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
 
 .. image:: https://img.shields.io/badge/License-BSD_2--Clause-orange.svg
    :target: https://opensource.org/licenses/BSD-2-Clause

doc/source/install.rst

@@ -43,28 +43,40 @@ The required dependencies for installing PyRASA are:
 
 .. code::
 
- numpy>=1.26, <3 
- pandas>=2.1, <3 
- scipy>=1.12
+ numpy >= 1.26
+ pandas >= 2.1 
+ scipy >= 1.12
  attrs 
  
 and
 
 .. code::
 
-    python>=3.11
+    python >= 3.11
 
 
 Optional dependencies
 =====================
 
 Optionally you can combine PyRASA with MNE Python to better integrate spectral parametrization in your
-M/EEG analysis workflow.
+M/EEG analysis workflow. If you already have an MNE Python installation running you can try to install PyRASA in the respective environment.
+If you don't already have MNE Python in your environment you can install PyRASA including its optional dependency 
+`mne <https://mne.tools/stable/index.html>` using either pip or conda-forge. 
 
-.. code::
+Using pip
+---------
+.. code:: bash
+    
+    pip install "pyrasa[mne]"
+
+Using conda-forge
+-----------------
+.. code:: bash
+    
+    conda install -c conda-forge pyrasa mne
 
-    mne
 
+For a more detailed instruction on how to configure your MNE Python installation please refer to the `mne installation guide <https://mne.tools/stable/install/manual_install.html#manual-install>`.
 
 
 

doc/source/tutorials.rst

@@ -3,7 +3,25 @@
 Tutorials
 =========
 
-This section contains a number of tutorials, to get you started with PyRASA.
+This section contains a number of tutorials, to get you started with PyRASA. 
+In order to easily run the tutorials you need to add some additional python libraries to your current environment.
+You can do so using pip or conda-forge.
+
+Using pip
+---------
+.. code:: bash
+    
+    pip install neurodsp seaborn
+
+Using conda-forge
+-----------------
+.. code:: bash
+    
+    conda install -c conda-forge neurodsp seaborn 
+
+If you want to use PyRASA together with MNE Python (see Tutorial 4. IRASA MNE). 
+You also need MNE Python installed in your current enviroment (see `install <https://schmidtfa.github.io/pyrasa/install.html>` for further instructions).
+
 
 Introductory
 ------------