diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..e1eb51d --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include README.rst +include LICENSE.txt + +recursive-include docs *.ipynb *.rst conf.py Makefile +recursive-exclude docs *checkpoint.ipynb \ No newline at end of file diff --git a/README.md b/README.rst similarity index 69% rename from README.md rename to README.rst index 70c6b9e..e1c554a 100644 --- a/README.md +++ b/README.rst @@ -9,7 +9,13 @@ A deep learning for raw time-domain EEG decoding toolbox. Installation ============ -Install pytorch from http://pytorch.org/. +First, install pytorch from http://pytorch.org/. +Then, install braindecode via pip: + +.. code-block:: bash + + pip install braindecode + Documentation ============= diff --git a/braindecode/models/__init__.py b/braindecode/models/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/braindecode.datasets.rst b/docs/source/braindecode.datasets.rst new file mode 100644 index 0000000..818601f --- /dev/null +++ b/docs/source/braindecode.datasets.rst @@ -0,0 +1,22 @@ +braindecode\.datasets package +============================= + +Submodules +---------- + +braindecode\.datasets\.signal\_target module +-------------------------------------------- + +.. automodule:: braindecode.datasets.signal_target + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: braindecode.datasets + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/braindecode.modules.rst b/docs/source/braindecode.modules.rst deleted file mode 100644 index f543140..0000000 --- a/docs/source/braindecode.modules.rst +++ /dev/null @@ -1,22 +0,0 @@ -braindecode\.modules package -============================ - -Submodules ----------- - -braindecode\.modules\.expression module ---------------------------------------- - -.. automodule:: braindecode.modules.expression - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: braindecode.modules - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/braindecode.rst b/docs/source/braindecode.rst index b3ed003..7211155 100644 --- a/docs/source/braindecode.rst +++ b/docs/source/braindecode.rst @@ -6,14 +6,9 @@ Subpackages .. toctree:: - braindecode.configs - braindecode.csp braindecode.datasets braindecode.experiments braindecode.models - braindecode.modules - braindecode.mywyrm - braindecode.test braindecode.torchext Submodules diff --git a/docs/source/braindecode.torchext.rst b/docs/source/braindecode.torchext.rst index bd639af..1213ebd 100644 --- a/docs/source/braindecode.torchext.rst +++ b/docs/source/braindecode.torchext.rst @@ -28,6 +28,14 @@ braindecode\.torchext\.losses module :undoc-members: :show-inheritance: +braindecode\.torchext\.modules module +------------------------------------- + +.. automodule:: braindecode.torchext.modules + :members: + :undoc-members: + :show-inheritance: + braindecode\.torchext\.util module ---------------------------------- diff --git a/setup.py b/setup.py index 12d2d01..0f9c8b1 100644 --- a/setup.py +++ b/setup.py @@ -1,11 +1,11 @@ -from setuptools import setup # Always prefer setuptools over distutils +from setuptools import setup, find_packages # Always prefer setuptools over distutils from codecs import open # To use a consistent encoding from os import path here = path.abspath(path.dirname(__file__)) # Get the long description from the relevant file -with open(path.join(here, 'README.md'), encoding='utf-8') as f: +with open(path.join(here, 'README.rst'), encoding='utf-8') as f: long_description = f.read() @@ -15,7 +15,7 @@ # Versions should comply with PEP440. For a discussion on single-sourcing # the version across setup.py and the project code, see # http://packaging.python.org/en/latest/tutorial.html#version - version='0.1.1', + version='0.1.2', description='A deep learning for raw time-domain EEG decoding toolbox.', long_description=long_description, #this is the @@ -56,6 +56,7 @@ # What does your project relate to? keywords='eeg deep-learning brain-state-decoding', - packages=['braindecode'], - + packages=find_packages(), + include_package_data=False, + zip_safe=False, )