Skip to content

Commit 3962201

Browse files
m-kowalskam-kowalska
authored
Merge pull request #153 from Neuroinflab/readmefix
Fixing readthedocs
2 parents 45753b5 + 67799ba commit 3962201

8 files changed

Lines changed: 122 additions & 421 deletions

File tree

‎.readthedocs.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
configuration: docs/source/conf.py
17+
18+
# We recommend specifying your dependencies to enable reproducible builds:
19+
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20+
python:
21+
install:
22+
- requirements: docs/source/requirements.txt

‎LICENSE.txt‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Corresponding SPDX licence
2+
BSD 3-Clause "New" or "Revised" License
3+
Licence ID
4+
BSD-3-Clause
5+
6+
7+
Licence text
8+
Copyright (c) 2019-2023, Chintaluri et al.
9+
All rights reserved.
10+
11+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
12+
13+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
14+
15+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
16+
17+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎MANIFEST.in‎

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,26 @@
11
include LICENSE.txt
22
include README.rst
3-
graft data
3+
include kcsd/data/gang_7x7_200/electrode_positions/elcoord_x_y_z
4+
include kcsd/data/gang_7x7_200/LFP/myLFP
5+
include kcsd/data/gang_7x7_200/morphology/*
6+
include kcsd/data/ball_and_stick_8/electrode_positions/elcoord_x_y_z
7+
include kcsd/data/ball_and_stick_8/LFP/myLFP
8+
include kcsd/data/ball_and_stick_8/morphology/*
9+
include kcsd/data/ball_and_stick_16/electrode_positions/elcoord_x_y_z
10+
include kcsd/data/ball_and_stick_16/LFP/myLFP
11+
include kcsd/data/ball_and_stick_16/morphology/*
12+
include kcsd/data/ball_and_stick_128/electrode_positions/elcoord_x_y_z
13+
include kcsd/data/ball_and_stick_128/LFP/myLFP
14+
include kcsd/data/ball_and_stick_128/morphology/*
15+
include kcsd/data/Y_shaped_neuron/electrode_positions/elcoord_x_y_z
16+
include kcsd/data/Y_shaped_neuron/LFP/myLFP
17+
include kcsd/data/Y_shaped_neuron/morphology/*
18+
include kcsd/data/Simple_with_branches/electrode_positions/elcoord_x_y_z
19+
include kcsd/data/Simple_with_branches/LFP/myLFP
20+
include kcsd/data/Simple_with_branches/morphology/*
21+
include kcsd/data/morphology/*
22+
include kcsd/data/sinsyn.mod
423
graft figures
5-
graft doc
6-
graft tests
7-
graft validation
8-
global-exclude *.py[cod] __pycache__ *.so
24+
graft docs
25+
graft tutorials
26+
global-exclude *.py[cod] __pycache__ *.so *.pdf *.npz *.png *.npy

‎README.rst‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
Kernel Current Source Density
22
=============================
33

4-
This 2.0 version of kCSD inverse method proposed in python3
4+
This 2.0 version of kCSD method.
5+
6+
Only supported for python 3.
7+
8+
59

610
Relevant Papers
711
---------------
@@ -41,11 +45,12 @@ More information on the tutorials is provided here `Tutorials!`_
4145

4246
.. _Tutorials!: /docs/source/TUTORIALS.rst
4347

44-
To have these tutorials and saved on your desktop, you will also need jupyter-notebook installed
48+
You can also save these tutorials on your desktop, for this you will
49+
need to install jupyter-notebook. Do this by
4550

4651
.. code-block:: bash
4752
48-
pip install jupyterlab
53+
pip install jupyter notebook
4954
5055
5156
Figures
@@ -83,7 +88,7 @@ Also included here are authors and their contributions, citation policy, contact
8388

8489
Earlier Stable versions
8590
-----------------------
86-
Please see git tags for earlier versions
91+
Please see git tags for earlier versions. These are not available as packages unfortunately.
8792

8893
- v1.2 corresponds to the first time kCSD-python released as a python package
8994
- v1.0 corresponds to the version with the test cases written inside tests folder

‎docs/source/conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@
5252

5353
# General information about the project.
5454
project = 'kCSD-python'
55-
copyright = '2019, Chintaluri et.al'
56-
author = 'Chintaluri et.al'
55+
copyright = '2019-2023, Chintaluri et al'
56+
author = 'Chintaluri et al'
5757

5858
# The version info for the project you're documenting, acts as replacement for
5959
# |version| and |release|, also used in various other places throughout the

0 commit comments

Comments
 (0)