Merge pull request #156 from Neuroinflab/pypiinstall

Pypi Install

Author: m-kowalska

README.rst

@@ -50,7 +50,7 @@ need to install jupyter-notebook. Do this by
 
 ..  code-block:: bash
 
-		 pip install jupyter notebook
+   pip install jupyter notebook
 
 
 Figures
@@ -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

docs/source/INSTALL.rst

@@ -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

docs/source/TUTORIALS.rst

@@ -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
 
 
 

docs/source/conf.py

@@ -17,9 +17,10 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../../'))
 
 
 # -- General configuration ------------------------------------------------
@@ -69,7 +70,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -99,7 +100,8 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
+html_static_path = []
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -147,8 +149,11 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'kCSD-python.tex', 'kCSD-python Documentation',
-     'Chintaluri et.al.', 'manual'),
+    (master_doc,
+     'kCSD-python.tex',
+     'kCSD-python Documentation',
+     'Chintaluri et al.',
+     'manual'),
 ]
 
 

docs/source/requirements.txt

@@ -1,6 +1,7 @@
 # Requirements for building documentation
 scipy
-numpy>=1.8.2
+numpy
+matplotlib
 numpydoc
 sphinx
 

setup.py

@@ -19,7 +19,7 @@ def readme():
 
 
 setup(name='kcsd',
-      version='2.0',
+      version='2.0.1',
       description='kernel current source density methods',
       long_description=readme(),
       classifiers=[
@@ -54,10 +54,10 @@ def readme():
                      'figures/*'
                      ]
                     },
-      install_requires=['numpy>=1.8.0',
-                        'scipy>=0.14.0',
-                        'matplotlib>=2.0'],
-      extras_require={'docs': ['numpydoc>=0.5',
-                               'sphinx>=1.2.2']},
+      install_requires=['numpy>=1.19',
+                        'scipy>=1.8.0',
+                        'matplotlib>=3.6'],
+      extras_require={'docs': ['numpydoc>=1.6.0',
+                               'sphinx>=5']},
       test_suite='kcsd.tests',
       zip_safe=False)