py-neuromodulation 0.1.1__tar.gz → 0.1.3__tar.gz

{py_neuromodulation-0.1.1 → py_neuromodulation-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py_neuromodulation
-Version: 0.1.1
+Version: 0.1.3
 Summary: Real-time analysis of intracranial neurophysiology recordings.
 Project-URL: Homepage, https://neuromodulation.github.io/py_neuromodulation/
 Project-URL: Documentation, https://neuromodulation.github.io/py_neuromodulation/
@@ -48,6 +48,7 @@ Requires-Dist: mne-bids>=0.8
 Requires-Dist: mne-connectivity
 Requires-Dist: mne-lsl>=1.2.0
 Requires-Dist: mrmr-selection
+Requires-Dist: msgpack
 Requires-Dist: msgpack>=1.1.0
 Requires-Dist: nibabel>=5.3.2
 Requires-Dist: nolds>=0.6.1
@@ -59,6 +60,7 @@ Requires-Dist: pyarrow>=14.0.2
 Requires-Dist: pybispectra>=1.2.0
 Requires-Dist: pydantic>=2.7.3
 Requires-Dist: pyparrm
+Requires-Dist: pyqt6
 Requires-Dist: pywebview
 Requires-Dist: scikit-learn>=0.24.2
 Requires-Dist: scikit-optimize

{py_neuromodulation-0.1.1 → py_neuromodulation-0.1.3}/docs/source/contributing.rst

@@ -17,7 +17,7 @@ To setup the python environment, type
     uv venv
 
 
-Depending on your operating system, activate the rye virtual environment: 
+Depending on your operating system, activate the python virtual environment: 
 
 ::
 

py_neuromodulation-0.1.3/docs/source/installation.rst

@@ -0,0 +1,58 @@
+Installation
+============
+
+py_neuromodulation requires at least python 3.11. For installation you can use pip:
+
+.. code-block::
+
+    pip install py-neuromodulation
+
+We recommend, however, using the package manager `uv <https://docs.astral.sh/uv/getting-started/installation/>`_, and setting up a clean virtual environment:
+
+.. code-block::
+
+    git clone https://github.com/neuromodulation/py_neuromodulation.git
+    uv python install 3.11
+    uv venv
+
+And then activating the virtual environment e.g. in Windows using:
+
+.. code-block::
+
+    .\.venv\Scripts\activate
+
+or in unix-based systems:
+
+.. code-block::
+
+    source .venv/bin/activate
+
+Then install the packages listed in the `pyproject.toml`:
+
+.. code-block::
+
+    uv sync
+
+The GUI can then simply be started by running:
+
+.. code-block::
+
+    run_gui
+
+If needed, install the documentation dependencies:
+
+.. code-block::
+
+    uv pip install -e .[docs]
+
+
+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 .

{py_neuromodulation-0.1.1 → py_neuromodulation-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ requires = ["hatchling"]
 
 [project]
 name = "py_neuromodulation"
-version = "0.1.1"
+version = "0.1.3"
 authors = [{ name = "Timon Merk", email = "timon.merk@charite.de" }]
 classifiers = [
   "Development Status :: 2 - Pre-Alpha",
@@ -59,9 +59,11 @@ dependencies = [
   "fooof",
   "nolds >=0.6.1",
   "pybispectra>=1.2.0",
-  "numba >= 0.60.0", # Required to avoid uv version conflicts with pybispectra
+  "numba >= 0.60.0",    # Required to avoid uv version conflicts with pybispectra
   # Graphing
   "matplotlib>=3.9.0",
+  "PyQt6",             # necessary for plotting
+  "msgpack",
   "seaborn >= 0.11",
   "scikit-optimize",
   "mrmr_selection",

py_neuromodulation-0.1.1/docs/source/installation.rst

@@ -1,46 +0,0 @@
-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