update pacakging (#15)

README.md

@@ -8,13 +8,9 @@ The documentation of neurodesign is available at [ReadTheDocs](http://neurodesig
 
 ## File description
 
-    *
-    |---- docs              Contains the source code to generate the documentation.
-    |                       with sphinx.
-    |
-    |---- examples          Contains scripts to perform a design optimalisation.
-    |
-    |---- source            Folder with the source code of the python package
-    |       |
-    |       |---- media     Folder contains the logo of neurodesign, which is used
-                            in the reports.
+```
+├── docs                    Contains the source code to generate the documentation with sphinx.
+├── examples                Contains scripts to perform a design optimalisation.
+└── neurodesign             Folder with the source code of the python package
+    └── media               Folder contains the logo of neurodesign, which is used in the reports.
+```

neurodesign/_version.py

@@ -0,0 +1,17 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = "0.2.3.dev25+g1a2b14b.d20240216"
+__version_tuple__ = version_tuple = (0, 2, 3, "dev25", "g1a2b14b.d20240216")

pyproject.toml

@@ -1,10 +1,76 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling", "hatch-vcs"]
+
+[project]
+authors = [{name = "Joke Durnez"}]
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved",
+    "Programming Language :: Python",
+    "Topic :: Software Development",
+    "Topic :: Scientific/Engineering",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Operating System :: Unix",
+    "Operating System :: MacOS",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12"
+]
+dependencies = [
+    "numpy>1.0.0",
+    "scipy>1.0.0",
+    "scikit-learn>0.15.0",
+    "pandas>0.15.0",
+    "progressbar>2.0",
+    "reportlab",
+    "pdfrw",
+    "matplotlib",
+    "seaborn"
+]
+description = "Package for design optimisation for fMRI experiments"
+# Version from setuptools_scm
+dynamic = ["version"]
+license = {text = "MIT"}
+maintainers = [{name = "Joke Durnez", email = "[email protected]"}]
+name = "neurodesign"
+readme = "README.md"
+requires-python = ">=3.8"
+
+[project.optional-dependencies]
+# A combination of dependencies useful for developers
+dev = [
+    "neurodesign[test]",
+    'pre-commit',
+    'tox'
+]
+# For running unit and docstring tests
+test = [
+    "coverage",
+    "pytest>=6.0.0",
+    "pytest-cov"
+]
+
 [tool.black]
 line-length = 100
 
 [tool.codespell]
 ignore-words = ".github/codespell_ignore_words.txt"
 skip = "examples/comparison_neurodesign.html,examples/comparison_neurodesign.ipynb"
 
+[tool.hatch.build.hooks.vcs]
+version-file = "neurodesign/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["neurodesign"]
+
+[tool.hatch.version]
+source = "vcs"
+
 [tool.isort]
 combine_as_imports = true
 line_length = 100