Skip to content

Commit

Permalink
update install with pip
Browse files Browse the repository at this point in the history
  • Loading branch information
timonmerk committed Sep 21, 2023
1 parent 7c2ac1b commit b624bee
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 7 deletions.
13 changes: 10 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
27 changes: 23 additions & 4 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -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]
import py_neuromodulation as py_nm

0 comments on commit b624bee

Please sign in to comment.