diff --git a/README.rst b/README.rst index 7d73d4d2..21ecc352 100644 --- a/README.rst +++ b/README.rst @@ -32,18 +32,25 @@ Find the documentation here http://py-neuromodulation.readthedocs.io for example Installation ============ -For installation, clone the repository and create a new virtual conda environment with at least python 3.10: +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 in a new new conda environment: + +.. code-block:: + + git clone https://github.com/neuromodulation/py_neuromodulation.git conda create -n pynm-test python=3.10 conda activate pynm-test -Then install the packages listed in the `pyproject.toml` with. +Then install the packages listed in the `pyproject.toml`: .. code-block:: - pip install .[dev] + pip install . Optionally the ipython kernel can be specified for the installed pynm-test conda environment: diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 07ae3aaa..f81616f2 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,16 +1,35 @@ Installation ============ -py_neurmodulation can be installed by cloning the repo and installing the dependencies in a virtual environment: +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 in a new new conda environment: .. code-block:: git clone https://github.com/neuromodulation/py_neuromodulation.git - conda create -n pynm-test python=3.11 + conda create -n pynm-test python=3.10 conda activate pynm-test -Then install the packages listed in the `pyproject.toml`. +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:: - pip install .[dev] \ No newline at end of file + import py_neuromodulation as py_nm \ No newline at end of file