Skip to content

Commit

Permalink
updating the readmes to include the new install
Browse files Browse the repository at this point in the history
  • Loading branch information
Chaitanya CHINTALURI committed Dec 22, 2023
1 parent 0ef41e5 commit f1301eb
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 21 deletions.
10 changes: 7 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ need to install jupyter-notebook. Do this by

.. code-block:: bash
pip install jupyter notebook
pip install jupyter notebook
Figures
Expand All @@ -69,9 +69,13 @@ This library includes all the necessary scripts to generate the figures for pape
Installation
------------

`kCSD-python Installation`_
.. code-block:: bash
user:~/$ pip install kcsd
`More Installations`_

.. _kCSD-python Installation : https://kcsd-python.readthedocs.io/en/latest/INSTALL.html
.. _More Installations : https://kcsd-python.readthedocs.io/en/latest/INSTALL.html


Documentation
Expand Down
29 changes: 15 additions & 14 deletions docs/source/INSTALL.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,31 @@
Installation
------------

Clone repository
~~~~~~~~~~~~~~~~

.. code-block:: bash
user:~$ git clone https://github.com/Neuroinflab/kCSD-python.git
user:~$ cd kCSD-python
user:~/kCSD-python$
Bash or Anaconda env
~~~~~~~~~~~~~~~~~~~~
From PyPi
~~~~~~~~~

.. code-block:: bash
user:~/kCSD-python$ pip install .
user:~$ pip install kcsd
or
From repository
~~~~~~~~~~~~~~~~

.. code-block:: bash
user:~$ git clone https://github.com/Neuroinflab/kCSD-python.git
user:~$ cd kCSD-python
user:~/kCSD-python$ python setup.py install
On Anaconda
~~~~~~~~~~~

.. code-block:: bash
(base)user:~/kCSD-python$ conda activate testkcsd
(testkcsd)user:~/kCSD-python$ pip install kcsd
Development and testing
Expand Down
6 changes: 2 additions & 4 deletions docs/source/TUTORIALS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,8 @@ install jupyter notebook on your desktop.

.. code-block:: bash
git clone https://github.com/Neuroinflab/kCSD-python.git
cd kCSD-python
pip install .
pip install jupyterlab
pip install kcsd
pip install jupyter notebook
Expand Down

0 comments on commit f1301eb

Please sign in to comment.