Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
timonmerk authored Sep 27, 2024
1 parent 2d6f219 commit e2899b4
Showing 1 changed file with 6 additions and 16 deletions.
22 changes: 6 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The original intention for writing this toolbox was movement decoding from invas
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.
Find the documentation here neuromodulation.github.io/py_neuromodulation/ for example usage and parametrization.

Installation
============
Expand All @@ -40,25 +40,15 @@ py_neuromodulation requires at least python 3.10. For installation you can use p
pip install py-neuromodulation
Alternatively you can also install the package in a conda environment:
Alternatively you can also clone the pacakge and install it using `uv <https://docs.astral.sh/uv/>`_:

.. code-block::
conda create -n pynm-test python=3.11
conda activate pynm-test
uv python install 3.10
uv venv
. .venv/bin/activate
uv sync
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:

Expand Down

0 comments on commit e2899b4

Please sign in to comment.