-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
33 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |