in prep for the pypi package

Author: Chaitanya CHINTALURI

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/source/requirements.txt

LICENSE.txt

@@ -5,7 +5,7 @@ BSD-3-Clause
 
 
 Licence text
-Copyright (c) 2017-2023, Chintaluri et al.
+Copyright (c) 2019-2023, Chintaluri et al.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

README.rst

@@ -1,7 +1,11 @@
 Kernel Current Source Density
 =============================
 
-This 2.0 version of kCSD inverse method proposed in python3
+This 2.0 version of kCSD method.
+
+Only supported for python 3.
+
+
 
 Relevant Papers
 ---------------
@@ -41,7 +45,8 @@ More information on the tutorials is provided here `Tutorials!`_
 
 .. _Tutorials!: /docs/source/TUTORIALS.rst
 
-To have these tutorials and saved on your desktop, you will also need jupyter-notebook installed
+You can also save these tutorials on your desktop, for this you will
+need to install jupyter-notebook. Do this by
 
 ..  code-block:: bash
 
@@ -83,7 +88,7 @@ Also included here are authors and their contributions, citation policy, contact
 
 Earlier Stable versions
 -----------------------
-Please see git tags for earlier versions
+Please see git tags for earlier versions. These are not available as packages unfortunately.
 
 - v1.2 corresponds to the first time kCSD-python released as a python package
 - v1.0 corresponds to the version with the test cases written inside tests folder

docs/source/conf.py

@@ -52,8 +52,8 @@
 
 # General information about the project.
 project = 'kCSD-python'
-copyright = '2019, Chintaluri et.al'
-author = 'Chintaluri et.al'
+copyright = '2019-2023, Chintaluri et al'
+author = 'Chintaluri et al'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

setup.py

@@ -34,10 +34,10 @@ def readme():
           'Topic :: Scientific/Engineering :: Medical Science Apps.',
           'Intended Audience :: Science/Research',
       ],
-      keywords='Eletrophysiology CSD LFP MEA',
+      keywords='Electrophysiology CSD LFP MEA',
       url='https://github.com/Neuroinflab/kCSD-python',
       author='Chaitanya Chintaluri et al',
-      license='BSD',
+      license='Modified BSD License',
       packages=find_packages(where="."),
       include_package_data=True,
       package_data={'kcsd':