finalized tutorials

README.md

@@ -17,7 +17,7 @@ PyRASA is a Python library designed to separate and parametrize aperiodic (fract
 
 
 ## Documentation
-Documentation for PyRASA, including detailed descriptions of functions, parameters, and examples, will soon be available [here].
+Documentation for PyRASA, including detailed descriptions of functions, parameters, and tutorials is available [here](https://schmidtfa.github.io/pyrasa/index.html).
 
 
 ### Installation

doc/source/conf.py

@@ -11,6 +11,8 @@
 
 import pyrasa
 
+# import pyrasa.irasa_mne
+
 project = 'PyRASA'
 copyright = '2024, Fabian Schmidt, Thomas Hartmann'
 author = 'Fabian Schmidt, Thomas Hartmann'
@@ -25,6 +27,7 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.napoleon',
     'numpydoc',
     'sphinx_gallery.gen_gallery',
     'sphinx.ext.mathjax',  # optional, if you need to render math
@@ -119,7 +122,7 @@
         'pyrasa': None,
     },
     'backreferences_dir': 'generated',
-    'examples_dirs': '../../examples',
+    'examples_dirs': 'examples',
     'within_subsection_order': 'ExampleTitleSortKey',
     'gallery_dirs': 'auto_examples',
     'filename_pattern': '^((?!sgskip).)*$',

doc/source/examples/custom_fit_functions.ipynb

@@ -18,7 +18,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -51,7 +51,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -75,7 +75,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
     {
@@ -108,8 +108,8 @@
        "  <tbody>\n",
        "    <tr>\n",
        "      <th>0</th>\n",
-       "      <td>-1.111201</td>\n",
-       "      <td>1.510531</td>\n",
+       "      <td>-1.246405</td>\n",
+       "      <td>1.480257</td>\n",
        "      <td>custom</td>\n",
        "      <td>0</td>\n",
        "    </tr>\n",
@@ -118,11 +118,11 @@
        "</div>"
       ],
       "text/plain": [
-       "          a         b fit_type  ch_name\n",
-       "0 -1.111201  1.510531   custom        0"
+       "          a         b fit_type ch_name\n",
+       "0 -1.246405  1.480257   custom       0"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 3,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -133,7 +133,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -142,7 +142,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [
     {
@@ -175,8 +175,8 @@
        "  <tbody>\n",
        "    <tr>\n",
        "      <th>0</th>\n",
-       "      <td>-1.125121</td>\n",
-       "      <td>1.500167</td>\n",
+       "      <td>-1.237573</td>\n",
+       "      <td>1.483932</td>\n",
        "      <td>custom</td>\n",
        "      <td>0</td>\n",
        "    </tr>\n",
@@ -185,11 +185,11 @@
        "</div>"
       ],
       "text/plain": [
-       "          a         b fit_type  ch_name\n",
-       "0 -1.125121  1.500167   custom        0"
+       "          a         b fit_type ch_name\n",
+       "0 -1.237573  1.483932   custom       0"
       ]
      },
-     "execution_count": 7,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -200,7 +200,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [
     {
@@ -225,8 +225,10 @@
        "    <tr style=\"text-align: right;\">\n",
        "      <th></th>\n",
        "      <th>mse</th>\n",
-       "      <th>r_squared</th>\n",
+       "      <th>R2</th>\n",
+       "      <th>R2_adj.</th>\n",
        "      <th>BIC</th>\n",
+       "      <th>BIC_adj.</th>\n",
        "      <th>AIC</th>\n",
        "      <th>fit_type</th>\n",
        "      <th>ch_name</th>\n",
@@ -235,19 +237,23 @@
        "  <tbody>\n",
        "    <tr>\n",
        "      <th>0</th>\n",
-       "      <td>0.007469</td>\n",
-       "      <td>0.978620</td>\n",
-       "      <td>-2900.899570</td>\n",
-       "      <td>-2909.676693</td>\n",
+       "      <td>0.006865</td>\n",
+       "      <td>0.979519</td>\n",
+       "      <td>0.979450</td>\n",
+       "      <td>-19.046324</td>\n",
+       "      <td>-25.395720</td>\n",
+       "      <td>-27.823447</td>\n",
        "      <td>custom</td>\n",
        "      <td>0</td>\n",
        "    </tr>\n",
        "    <tr>\n",
        "      <th>0</th>\n",
-       "      <td>0.000350</td>\n",
-       "      <td>0.998963</td>\n",
-       "      <td>-4721.685378</td>\n",
-       "      <td>-4730.462501</td>\n",
+       "      <td>0.000361</td>\n",
+       "      <td>0.998907</td>\n",
+       "      <td>0.998903</td>\n",
+       "      <td>-37.861877</td>\n",
+       "      <td>-44.211273</td>\n",
+       "      <td>-46.638999</td>\n",
        "      <td>custom</td>\n",
        "      <td>0</td>\n",
        "    </tr>\n",
@@ -256,12 +262,16 @@
        "</div>"
       ],
       "text/plain": [
-       "        mse  r_squared          BIC          AIC fit_type  ch_name\n",
-       "0  0.007469   0.978620 -2900.899570 -2909.676693   custom        0\n",
-       "0  0.000350   0.998963 -4721.685378 -4730.462501   custom        0"
+       "        mse        R2   R2_adj.        BIC   BIC_adj.        AIC fit_type  \\\n",
+       "0  0.006865  0.979519  0.979450 -19.046324 -25.395720 -27.823447   custom   \n",
+       "0  0.000361  0.998907  0.998903 -37.861877 -44.211273 -46.638999   custom   \n",
+       "\n",
+       "  ch_name  \n",
+       "0       0  \n",
+       "0       0  "
       ]
      },
-     "execution_count": 8,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -295,7 +305,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.4"
+   "version": "3.12.6"
   }
  },
  "nbformat": 4,

doc/source/index.rst

@@ -95,6 +95,8 @@ If you are using PyRASA, it would be nice if you could additionally cite us (whe
 Schmidt F., Hartmann T., & Weisz, N. (2049). PyRASA - Spectral parameterization in python based on IRASA. *SOME JOURNAL THAT LIKES US*
 
 
+
+
 .. toctree::
    :hidden:
 

doc/source/tutorials.rst

@@ -1,4 +1,4 @@
-
+:orphan:
 =========
 Tutorials
 =========