py-neuromodulation 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

{py_neuromodulation-0.0.3.dist-info → py_neuromodulation-0.0.5.dist-info}/METADATA

@@ -1,182 +1,185 @@
-Metadata-Version: 2.1
-Name: py_neuromodulation
-Version: 0.0.3
-Summary: Real-time analysis of intracranial neurophysiology recordings.
-Author-email: Timon Merk <timon.merk@charite.de>
-Maintainer: Timon Merk
-License: MIT License
-        
-        Copyright (c) 2021 Interventional Cognitive Neuromodulation - Neumann Lab Berlin
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
-Project-URL: bugtracker, https://github.com/neuromodulation/py_neuromodulation/issues
-Project-URL: repository, https://github.com/neuromodulation/py_neuromodulation
-Keywords: real-time,eeg,ieeg,dbs,ecog,electrocorticography,deep-brain-stimulation,machine-learning
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: License :: OSI Approved :: MIT License 
-Classifier: Programming Language :: Python
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.10
-Description-Content-Type: text/x-rst
-License-File: LICENSE
-Requires-Dist: mne
-Requires-Dist: filterpy >=1.4.5
-Requires-Dist: fooof
-Requires-Dist: imbalanced-learn
-Requires-Dist: matplotlib >=3.3.4
-Requires-Dist: mne-bids >=0.8
-Requires-Dist: mne-connectivity
-Requires-Dist: mrmr-selection
-Requires-Dist: nolds
-Requires-Dist: numpy >=1.21.2
-Requires-Dist: pandas >=1.2.2
-Requires-Dist: pip
-Requires-Dist: pynput
-Requires-Dist: pybids
-Requires-Dist: scikit-image
-Requires-Dist: scikit-learn >=0.24.2
-Requires-Dist: scikit-optimize
-Requires-Dist: scipy >=1.7.1
-Requires-Dist: seaborn >=0.11
-Requires-Dist: notebook
-Requires-Dist: ipython
-Requires-Dist: pybispectra >=1.0.0
-Requires-Dist: pyparrm
-Requires-Dist: pyarrow >=14.0.2
-Requires-Dist: joblib >=1.3.2
-Requires-Dist: black >=24.2.0
-Requires-Dist: pytest >=8.0.2
-Requires-Dist: wget
-Provides-Extra: dev
-Requires-Dist: black ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: pytest-cov ; extra == 'dev'
-
-py_neuromodulation
-==================
-
-Analyzing neural data can be a troublesome, trial and error prone,
-and beginner unfriendly process. *py_neuromodulation* allows using a simple
-interface for extraction of established neurophysiological features and includes commonly applied pre -and postprocessing methods.
-
-Only **time series data** with a corresponding **sampling frequency** are required for feature extraction.
-
-The output will be a `pandas.DataFrame <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html>`_ including different time-resolved computed features. Internally a **stream** get's initialized,
-which resembles an *online* data-stream that can in theory also be be used with a hardware acquisition system. 
-
-The following features are currently included:
-
-* oscillatory: fft, stft or bandpass filtered band power
-* `temporal waveform shape <https://www.sciencedirect.com/science/article/pii/S1364661316302182>`_
-* `fooof <https://fooof-tools.github.io/fooof/>`_
-* `mne_connectivity estimates <https://mne.tools/mne-connectivity/stable/index.html>`_ 
-* `Hjorth parameter <https://en.wikipedia.org/wiki/Hjorth_parameters>`_
-* `non-linear dynamical estimates <https://nolds.readthedocs.io/en/latest/>`_
-* various burst features
-* line length 
-* and more...
-
-
-Find here the preprint of **py_neuromodulation** called *"Invasive neurophysiology and whole brain connectomics for neural decoding in patients with brain implants"* [1]_.
-
-The original intention for writing this toolbox was movement decoding from invasive brain signals [2]_.
-The application however could be any neural decoding problem.
-*py_neuromodulation* offers wrappers around common practice machine learning methods for efficient analysis.
-
-Find the documentation here http://py-neuromodulation.readthedocs.io for example usage and parametrization.
-
-Installation
-============
-
-py_neuromodulation requires at least python 3.10. For installation you can use pip:
-
-.. code-block::
-
-    pip install py-neuromodulation
-
-
-We recommend however installing the package using `rye <https://rye-up.com/guide/installation/>`_:
-
-.. code-block::
-
-    git clone https://github.com/neuromodulation/py_neuromodulation.git
-    rye pin 3.11
-    rye sync
-
-And then activating the virtual environment e.g. in Windows using:
-
-.. code-block::
-
-    .\.venv\Scripts\activate
-
-Alternatively you can also install the package in a conda environment:
-
-    conda create -n pynm-test python=3.11
-    conda activate pynm-test
-
-Then install the packages listed in the `pyproject.toml`:
-
-.. code-block::
-
-    pip install .
-
-
-Optionally the ipython kernel can be specified for the installed pynm-test conda environment:
-
-.. code-block::
-
-    ipython kernel install --user --name=pynm-test
-
-Then *py_neuromodulation* can be imported via:
-
-.. code-block::
-
-    import py_neuromodulation as nm
-
-Basic Usage
-===========
-
-.. code-block:: python
-    
-    import py_neuromodulation as nm
-    import numpy as np
-    
-    NUM_CHANNELS = 5
-    NUM_DATA = 10000
-    sfreq = 1000  # Hz
-    sampling_rate_features_hz = 3  # Hz
-
-    data = np.random.random([NUM_CHANNELS, NUM_DATA])
-
-    stream = nm.Stream(sfreq=sfreq, data=data, sampling_rate_features_hz=sampling_rate_features_hz)
-    features = stream.run()
-
-Check the `Usage <https://py-neuromodulation.readthedocs.io/en/latest/usage.html>`_ and `First examples <https://py-neuromodulation.readthedocs.io/en/latest/auto_examples/plot_0_first_demo.html>`_ for further introduction.
-
-Contact information
--------------------
-For any question or suggestion please find my contact
-information at `my GitHub profile <https://github.com/timonmerk>`_.
-
-References
-----------
-
-.. [1] Merk, T. et al. *Invasive neurophysiology and whole brain connectomics for neural decoding in patients with brain implants*, `https://doi.org/10.21203/rs.3.rs-3212709/v1` (2023).
-.. [2] Merk, T. et al. *Electrocorticography is superior to subthalamic local field potentials for movement decoding in Parkinson’s disease*. Elife 11, e75126, `https://doi.org/10.7554/eLife.75126` (2022).
+Metadata-Version: 2.3
+Name: py_neuromodulation
+Version: 0.0.5
+Summary: Real-time analysis of intracranial neurophysiology recordings.
+Project-URL: bugtracker, https://github.com/neuromodulation/py_neuromodulation/issues
+Project-URL: repository, https://github.com/neuromodulation/py_neuromodulation
+Author-email: Timon Merk <timon.merk@charite.de>
+Maintainer: Timon Merk
+License: MIT License
+        
+        Copyright (c) 2021 Interventional Cognitive Neuromodulation - Neumann Lab Berlin
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: dbs,deep-brain-stimulation,ecog,eeg,electrocorticography,ieeg,machine-learning,real-time
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: filterpy>=1.4.5
+Requires-Dist: fooof
+Requires-Dist: hatch>=1.9.4
+Requires-Dist: imbalanced-learn
+Requires-Dist: joblib>=1.3.2
+Requires-Dist: matplotlib>=3.9.0
+Requires-Dist: mne
+Requires-Dist: mne-bids>=0.8
+Requires-Dist: mne-connectivity
+Requires-Dist: mne-lsl>=1.2.0
+Requires-Dist: mrmr-selection
+Requires-Dist: nibabel>=5.2.1
+Requires-Dist: nolds
+Requires-Dist: numpy>=1.21.2
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: pip>=24.2
+Requires-Dist: pyarrow>=14.0.2
+Requires-Dist: pybispectra>=1.0.0
+Requires-Dist: pydantic>=2.7.3
+Requires-Dist: pynput
+Requires-Dist: pyparrm
+Requires-Dist: pyqt5
+Requires-Dist: scikit-image
+Requires-Dist: scikit-learn>=0.24.2
+Requires-Dist: scikit-optimize
+Requires-Dist: scipy>=1.7.1
+Requires-Dist: seaborn>=0.11
+Requires-Dist: statsmodels
+Provides-Extra: dev
+Requires-Dist: notebook; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-sugar; extra == 'dev'
+Requires-Dist: pytest>=8.0.2; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: notebook; extra == 'docs'
+Requires-Dist: numpydoc; extra == 'docs'
+Requires-Dist: pydata-sphinx-theme; extra == 'docs'
+Requires-Dist: pytest-cov; extra == 'docs'
+Requires-Dist: pytest-sugar; extra == 'docs'
+Requires-Dist: pytest>=8.0.2; extra == 'docs'
+Requires-Dist: recommonmark; extra == 'docs'
+Requires-Dist: ruff; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-gallery; extra == 'docs'
+Requires-Dist: sphinx-togglebutton; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest-xdist; extra == 'test'
+Requires-Dist: pytest>=8.0.2; extra == 'test'
+Description-Content-Type: text/x-rst
+
+py_neuromodulation
+==================
+
+Analyzing neural data can be a troublesome, trial and error prone,
+and beginner unfriendly process. *py_neuromodulation* allows using a simple
+interface for extraction of established neurophysiological features and includes commonly applied pre -and postprocessing methods.
+
+Only **time series data** with a corresponding **sampling frequency** are required for feature extraction.
+
+The output will be a `pandas.DataFrame <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html>`_ including different time-resolved computed features. Internally a **stream** get's initialized,
+which resembles an *online* data-stream that can in theory also be be used with a hardware acquisition system. 
+
+The following features are currently included:
+
+* oscillatory: fft, stft or bandpass filtered band power
+* `temporal waveform shape <https://www.sciencedirect.com/science/article/pii/S1364661316302182>`_
+* `fooof <https://fooof-tools.github.io/fooof/>`_
+* `mne_connectivity estimates <https://mne.tools/mne-connectivity/stable/index.html>`_ 
+* `Hjorth parameter <https://en.wikipedia.org/wiki/Hjorth_parameters>`_
+* `non-linear dynamical estimates <https://nolds.readthedocs.io/en/latest/>`_
+* various burst features
+* line length 
+* and more...
+
+
+Find here the preprint of **py_neuromodulation** called *"Invasive neurophysiology and whole brain connectomics for neural decoding in patients with brain implants"* [1]_.
+
+The original intention for writing this toolbox was movement decoding from invasive brain signals [2]_.
+The application however could be any neural decoding problem.
+*py_neuromodulation* offers wrappers around common practice machine learning methods for efficient analysis.
+
+Find the documentation here http://py-neuromodulation.readthedocs.io for example usage and parametrization.
+
+Installation
+============
+
+py_neuromodulation requires at least python 3.10. For installation you can use pip:
+
+.. code-block::
+
+    pip install py-neuromodulation
+
+Alternatively you can also install the package in a conda environment:
+
+.. code-block::
+
+    conda create -n pynm-test python=3.11
+    conda activate pynm-test
+
+Then install the packages listed in the `pyproject.toml`:
+
+.. code-block::
+
+    pip install .
+
+
+Optionally the ipython kernel can be specified for the installed pynm-test conda environment:
+
+.. code-block::
+
+    ipython kernel install --user --name=pynm-test
+
+Then *py_neuromodulation* can be imported via:
+
+.. code-block::
+
+    import py_neuromodulation as nm
+
+Basic Usage
+===========
+
+.. code-block:: python
+    
+    import py_neuromodulation as nm
+    import numpy as np
+    
+    NUM_CHANNELS = 5
+    NUM_DATA = 10000
+    sfreq = 1000  # Hz
+    sampling_rate_features_hz = 3  # Hz
+
+    data = np.random.random([NUM_CHANNELS, NUM_DATA])
+
+    stream = nm.Stream(sfreq=sfreq, data=data, sampling_rate_features_hz=sampling_rate_features_hz)
+    features = stream.run()
+
+Check the `Usage <https://py-neuromodulation.readthedocs.io/en/latest/usage.html>`_ and `First examples <https://py-neuromodulation.readthedocs.io/en/latest/auto_examples/plot_0_first_demo.html>`_ for further introduction.
+
+Contact information
+-------------------
+For any question or suggestion please find my contact
+information at `my GitHub profile <https://github.com/timonmerk>`_.
+
+References
+----------
+
+.. [1] Merk, T. et al. *Invasive neurophysiology and whole brain connectomics for neural decoding in patients with brain implants*, `https://doi.org/10.21203/rs.3.rs-3212709/v1` (2023).
+.. [2] Merk, T. et al. *Electrocorticography is superior to subthalamic local field potentials for movement decoding in Parkinson’s disease*. Elife 11, e75126, `https://doi.org/10.7554/eLife.75126` (2022).

py_neuromodulation-0.0.5.dist-info/RECORD

@@ -0,0 +1,83 @@
+py_neuromodulation/FieldTrip.py,sha256=SNP_hmHWbOHhnoZqk6hS_aUMRPzuqoZuvojzg2BvvUw,18008
+py_neuromodulation/__init__.py,sha256=R5uKBJtyVshkLnAlkTLxCwHg8gBhmRWvgVM2_vLsT0M,2670
+py_neuromodulation/_write_example_dataset_helper.py,sha256=2I3FMumu6fgvvn8KPNwSqppCu3cgaIxJP5GzYEwt1fI,2524
+py_neuromodulation/grid_cortex.tsv,sha256=k2QOkHY1ej3lJ33LD6DOPVlTynzB3s4BYaoQaoUCyYc,643
+py_neuromodulation/grid_subcortex.tsv,sha256=oCQDYLDdYSa1DAI9ybwECfuzWulFzXqKHyf7oZ1oDBM,25842
+py_neuromodulation/nm_IO.py,sha256=7QtlKKiTcSBOfYusyfbF38Piu_MgQQdp1g6VRoA0Af8,11335
+py_neuromodulation/nm_RMAP.py,sha256=4hdB_LytcP1QOHEXMQeFa1fRm4_WNu_NgYyqOo8kNiE,15007
+py_neuromodulation/nm_analysis.py,sha256=A69X218R4qZl9pEGz_fmq94BjN5UzDir_EllR87bU4Q,35610
+py_neuromodulation/nm_artifacts.py,sha256=EyFx7xr2O0DHPXgrFmFeW52jlxKv3Zt-ItQy97ec-a4,843
+py_neuromodulation/nm_bispectra.py,sha256=vmaLeNLlxejBFsEcKDddd-75299KPUTtsJM6hnAEdhI,5569
+py_neuromodulation/nm_bursts.py,sha256=1Yns30S4fYi0slo0oje86JPCs4IOTmREuCHPI6QwGRc,11234
+py_neuromodulation/nm_coherence.py,sha256=dJVTPXeYxub4cM-TYQ21-j-3588ml2jTHtsEgQFEtdE,8731
+py_neuromodulation/nm_database.py,sha256=R7KetIS9Wv-q5OSziEcUFYVk0LLrRaVD96JbTt16A4E,4749
+py_neuromodulation/nm_decode.py,sha256=nn2sODnvDj5dZKAR3RucyKm90W65tLOI9jQvq5-a3C0,33176
+py_neuromodulation/nm_define_nmchannels.py,sha256=rjPJMMhHcsMF_TKpXhekHfOPwZlHklhoofNiKJQrlu0,10537
+py_neuromodulation/nm_features.py,sha256=da6Ah5qgddEije6SfxQXhzZVQ1QKpITmBC1ozr-A4Cc,4975
+py_neuromodulation/nm_filter.py,sha256=cWoF7a5Vn2OjCSGsEed2JRZJEsI4cajpht3xExGIEZg,7570
+py_neuromodulation/nm_filter_preprocessing.py,sha256=JuYBzVkpDTZP8WnHCyKdTEi9NW-JbRAXxhW83RAyUCs,2882
+py_neuromodulation/nm_fooof.py,sha256=l7hAa3BQ6q-aFNlKhMfgsoiIpPDW_KpWko_EFMRVma8,5079
+py_neuromodulation/nm_generator.py,sha256=kyVmI6R-TOhq5EATLpZND311oFP1Xx9ey_ieGf529nI,1403
+py_neuromodulation/nm_hjorth_raw.py,sha256=DptET2nFi8dPSuzt4eTltul4Mg5k709VWdnKSVVc4Xw,1777
+py_neuromodulation/nm_kalmanfilter.py,sha256=jpJXwg4cxiqHnwgMVMA6A3b_I4q95zotafhDyJdhOZw,1983
+py_neuromodulation/nm_linelength.py,sha256=GUZ39tl3Bx3UT5MmAFJ15bvETxheS-0Uynv7Aunw8pY,626
+py_neuromodulation/nm_logger.py,sha256=hcE2LiSIyJES5IeFw54QAhqVqbjdO3YnyUGJ9oaRTrE,2181
+py_neuromodulation/nm_mne_connectivity.py,sha256=h_JOgCc3qV1Awpnlm61LPiTcemOBjOlFnEqtqhLjcRk,5724
+py_neuromodulation/nm_mnelsl_generator.py,sha256=dEwVZwK9SgFjqf-N7I8n08Dgt__J6aqJue-zNoCl5rA,2897
+py_neuromodulation/nm_mnelsl_stream.py,sha256=lXGR7u99PhHdP8TsywWDDfbP1Msj7TIKUTtxui2-v2E,4488
+py_neuromodulation/nm_nolds.py,sha256=gsrCQBEfKstDdkYfbhPoZq5jU6s2C450NmbO46R9F3w,3460
+py_neuromodulation/nm_normalization.py,sha256=JbGOntJVKnj2j2RjQ6F4OQQS1gUjuu4TAnBmB5ilu4Q,5492
+py_neuromodulation/nm_oscillatory.py,sha256=YUeCQHV6hOKlWFH3bqHbT1FWVLKV7vHlaMsAEkXmpMc,14095
+py_neuromodulation/nm_plots.py,sha256=3n0lrRVj1iDkPjO4dbGHdjECp47ygMMvkH1Vi31PYVA,16679
+py_neuromodulation/nm_preprocessing.py,sha256=MHNOAisKgDN0qEIFoCw4eGNw6aoDMTFgx2AmoFVyqlY,3278
+py_neuromodulation/nm_projection.py,sha256=YMa0HIwsAvmk68FuzrzLe2APtLhzvSPAyRMZ0MtHw6o,14720
+py_neuromodulation/nm_rereference.py,sha256=ecixjJdhiyPGGID0hMvSPrTv_WZKhgKMDLHjM2Txifo,3354
+py_neuromodulation/nm_resample.py,sha256=vYkYfaG8duUbnJ0ssXhqUM6-3sUJP5NesPgqEkJ0g9w,1276
+py_neuromodulation/nm_run_analysis.py,sha256=xXGVCF7d0PLroZljktlGbMnx5B4t6RH918uTFvN6AiM,11261
+py_neuromodulation/nm_settings.py,sha256=IrRBcw0F3cv_VlfnEN8nReEfwopWjY8aiVR45w4J9Ew,10068
+py_neuromodulation/nm_settings.yaml,sha256=rnKOvFt06Pk3VQjyIMh4UcnIufxzSZBr3Ag7s8rhyEQ,5502
+py_neuromodulation/nm_sharpwaves.py,sha256=d_zUXVX5b9YRXOm0F5S9l3-SAaONJhKzhj1uK3SGUk0,16527
+py_neuromodulation/nm_stats.py,sha256=8lbG85VixiQNT1hLMVVQPUoZbhZFx-xyE3w7nV193fE,15318
+py_neuromodulation/nm_stream.py,sha256=7cSIl8JCwLOzBu6nFnDjHc5pPKcyM2ptcpg1T-TKcwA,13851
+py_neuromodulation/nm_stream_abc.py,sha256=OKoZJu2eZTIuuLNyX6sGoMXsr8ryU1T770XyKUpndqc,6155
+py_neuromodulation/nm_types.py,sha256=dSmqnLHaSPqBk32Farr3r9SptMyZBdWX8XW0RjBmjv4,5497
+py_neuromodulation/ConnectivityDecoding/Automated Anatomical Labeling 3 (Rolls 2020).nii,sha256=Sp-cjF_AuT0Tlilb5s8lB14hVgkXJiR2uKMS9nOQOeg,902981
+py_neuromodulation/ConnectivityDecoding/_get_grid_hull.m,sha256=2RPDGotbLsCzDJLFB2JXatJtfOMno9UUBCBnsOuse8A,714
+py_neuromodulation/ConnectivityDecoding/_get_grid_whole_brain.py,sha256=VsInAIADIf9d3unxUSN0B50aU472IQocGZ-kyG8A7Fc,3066
+py_neuromodulation/ConnectivityDecoding/_helper_write_connectome.py,sha256=1DNrccrJqrH5PIW2yp24xbyqRrsRz98Gof5aPQZUUUE,3423
+py_neuromodulation/ConnectivityDecoding/mni_coords_cortical_surface.mat,sha256=AZc0mgiAiqXVAxAnfxwICeh-dQX62RfTeRN_knS-i60,11622
+py_neuromodulation/ConnectivityDecoding/mni_coords_whole_brain.mat,sha256=YxT9nrXZ2IECheEhN1SgSsqNyihHUTLuZQ7o5yP4Q-c,29864
+py_neuromodulation/ConnectivityDecoding/rmap_func_all.nii,sha256=WjVA02B2cGNi670_45fdNssspf8GKbkKgRStZ2d4_FU,7221384
+py_neuromodulation/ConnectivityDecoding/rmap_struc.nii,sha256=XsEMjsCxjAsMFvw1_jpQ-wIU2BUuZ_lISPwMa7zDmDk,7221384
+py_neuromodulation/data/README,sha256=8PhEkUm8F2NgL7A5co1CgfumAMB14v5XPIbk54SvtAE,708
+py_neuromodulation/data/dataset_description.json,sha256=HMHtmF0bbw9XO79GAyRt8urpEyxRJ5A1REcYos8D2s0,122
+py_neuromodulation/data/participants.json,sha256=S4rrcSAmLcL_jLk9IY_cwJBipl8OwwCvouZ7tsgdldw,756
+py_neuromodulation/data/participants.tsv,sha256=-dg_i5N4I-Cp1l21433z1lDjXUmcuTn8S3UqkxPvgdI,77
+py_neuromodulation/data/sub-testsub/ses-EphysMedOff/sub-testsub_ses-EphysMedOff_scans.tsv,sha256=iz6Nvf_E5jChjacmO_eAxX7Y8rR8v03-gGdUeBlyDVY,89
+py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_space-mni_coordsystem.json,sha256=dq0Vc2fIR-YvbCEqBb7lq3P_YkOOzkKe1Hh-a1gd46E,118
+py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_space-mni_electrodes.tsv,sha256=Kr9vKh1qnnwFQE0Cet7PkeVuuGx1u-CT_xXs4qucezg,722
+py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_channels.tsv,sha256=ZSixrfpSlNEfmv0diaJ96usFPwPtO_dA6CCDYDp85KY,779
+py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.eeg,sha256=NnQeMDrKpeK3lctIZ5Bzh85UMTs5OCUCaivn_NU5rc4,760040
+py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.json,sha256=nRPEWAa0isyDKbeW1IPhL9ECWkzqfQw1sKwJkZU3vbk,474
+py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.vhdr,sha256=-QEHwQjJb9Hp9yudEawqhQl8vrD8bYqiuvlF4cyPNg0,988
+py_neuromodulation/data/sub-testsub/ses-EphysMedOff/ieeg/sub-testsub_ses-EphysMedOff_task-gripforce_run-0_ieeg.vmrk,sha256=BD-VmcKe7dR0vGzzkv4c09QnSwc3zYeAWDGJIzWEOI0,540
+py_neuromodulation/liblsl/libpugixml.so.1.12,sha256=_bCOHUjcnGpDiROg1qjgty8ZQhcKHSnaCIP6SMgw6SY,240248
+py_neuromodulation/liblsl/linux/bionic_amd64/liblsl.1.16.2.so,sha256=YXFbA23CQqWg6mWhk-73WY9gSx79NtgnBr6UFVByC2I,1033592
+py_neuromodulation/liblsl/linux/bookworm_amd64/liblsl.1.16.2.so,sha256=3gKI0HsheWJvFgZdnT27Ev824y7rkOOCVRiHdAlKHUM,791688
+py_neuromodulation/liblsl/linux/focal_amd46/liblsl.1.16.2.so,sha256=OCVevlOtKPblu7lWFN_x4HIibxfihgoPzQtGjsYEXUo,923264
+py_neuromodulation/liblsl/linux/jammy_amd64/liblsl.1.16.2.so,sha256=MSmfv900ShdCj3-ipsADxmbiTg3WoZ_SvUrByeZB45g,935392
+py_neuromodulation/liblsl/linux/jammy_x86/liblsl.1.16.2.so,sha256=MSmfv900ShdCj3-ipsADxmbiTg3WoZ_SvUrByeZB45g,935392
+py_neuromodulation/liblsl/linux/noble_amd64/liblsl.1.16.2.so,sha256=-p_sEh6LuxDKKVVcT5Y0Loeq7FK11LoE34RmMIKqdaw,3009496
+py_neuromodulation/liblsl/macos/amd64/liblsl.1.16.2.dylib,sha256=7BLTPGbq7ISuG3ZdLUem7fER6ZXrYYryY477b3j4lNw,807896
+py_neuromodulation/liblsl/macos/arm64/liblsl.1.16.0.dylib,sha256=UD228wOmdFIY9WKmpYgWKeJuVQ6wqI6K2EWWk1G3vM8,758048
+py_neuromodulation/liblsl/windows/amd64/liblsl.1.16.2.dll,sha256=M4tzeUOkvXv5_3GZheWJJ74q1AAIIGmcEZLugJIHxGo,804864
+py_neuromodulation/liblsl/windows/x86/liblsl.1.16.2.dll,sha256=UBdyYfWp7CpydLo1I0nsCSM1uHnnbNrF2FF1fHuOops,599040
+py_neuromodulation/plots/STN_surf.mat,sha256=Hh2nfQRmP0TYIt8SWV-ajKnC8yk7EmBoAj1c6RMoi9g,124526
+py_neuromodulation/plots/Vertices.mat,sha256=k72WB8-0Datt-bRScxcfpp38LBPHV34zzodS49kQAgs,3709780
+py_neuromodulation/plots/faces.mat,sha256=gWSr-9qNxsAPoG8q-muNnaFZHVHGKqnKN0j3Q1JfMk4,2859245
+py_neuromodulation/plots/grid.mat,sha256=G3MYIVcvk8lbf_kKWIe3lZZ4d0QV6HkoLsOFN1A2vhE,775
+py_neuromodulation/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_neuromodulation-0.0.5.dist-info/METADATA,sha256=5IJGPs-8SN-Glc-oqVZ1QmTkJMn0SJLx5jQRjz0DO9M,7439
+py_neuromodulation-0.0.5.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+py_neuromodulation-0.0.5.dist-info/licenses/LICENSE,sha256=EMBwuBRPBo-WkHSjqxZ55E6j95gKNBZ8x30pt-VGfrM,1118
+py_neuromodulation-0.0.5.dist-info/RECORD,,

{py_neuromodulation-0.0.3.dist-info → py_neuromodulation-0.0.5.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

{py_neuromodulation-0.0.3.dist-info → py_neuromodulation-0.0.5.dist-info/licenses}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Interventional Cognitive Neuromodulation - Neumann Lab Berlin
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Interventional Cognitive Neuromodulation - Neumann Lab Berlin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/build/_downloads/09df217f95985497f45d69e2d4bdc5b1/plot_2_example_add_feature.py

@@ -1,68 +0,0 @@
-"""
-===================
-Adding New Features 
-===================
-
-"""
-
-import py_neuromodulation as pn
-from py_neuromodulation import nm_features_abc
-import numpy as np
-from typing import Iterable
-
-# %%
-# In this example we will demonstrate how a new feature can be added to the existing feature pipeline.
-# This can be done simply by adding an object of the inherited :class:`~nm_features_abc.Feature` 
-# class to the stream `stream.run_analysis.features.features` list.
-
-data = np.random.random([1, 1000])
-
-stream = pn.Stream(sfreq=1000, data=data, sampling_rate_features_hz=10, verbose=False,)
-
-class NewFeature(nm_features_abc.Feature):
-    
-    def __init__(
-        self, settings: dict, ch_names: Iterable[str], sfreq: float
-    ) -> None:
-        self.s = settings
-        self.ch_names = ch_names
-    
-    def calc_feature(self, data: np.array, features_compute: dict) -> dict:
-        for ch_idx, ch in enumerate(self.ch_names):
-            features_compute[f"new_feature_{ch}"] = np.mean(data[ch_idx, :])
-
-        return features_compute
-
-    def test_settings():
-        pass
-
-newFeature = NewFeature(stream.settings, list(stream.nm_channels["name"]), stream.sfreq)
-stream.run_analysis.features.features.append(newFeature)
-
-features = stream.run_analysis.process(data)
-feature_name = f"new_feature_{stream.nm_channels['name'][0]}"
-
-print(f"{feature_name}: {features[feature_name]}")
-
-# %%
-# This example shows a simple newly instantiated feature class called `NewFeature`.
-# The instantiated `newFeature` object could then be added to the existing feature list by calling 
-# `stream.run_analysis.features.features.append(newFeature)`.
-#
-# To permanently add a novel feature, the new feature class needs to be added to 
-# the :class:`~nm_features` class. This can be done by inserting the feature_name in 
-# in the :class:`~nm_features.Feature` init function:
-# 
-# .. code-block:: python
-#
-#    for feature in s["features"]:
-#        if s["features"][feature] is False:
-#            continue
-#        match feature:
-#            case "new_feature":
-#                FeatureClass = nm_new_feature.NewFeature
-#            ...
-#
-# The new feature class can then be used by setting the `settings["feature"]["new_feature"]` value in the 
-# settings to true.
-#