junifer 0.0.8.dev184__tar.gz → 0.0.8.dev189__tar.gz

{junifer-0.0.8.dev184 → junifer-0.0.8.dev189}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: junifer
-Version: 0.0.8.dev184
+Version: 0.0.8.dev189
 Summary: JUelich NeuroImaging FEature extractoR
 Author-email: Fede Raimondo <f.raimondo@fz-juelich.de>, Synchon Mandal <s.mandal@fz-juelich.de>
 Maintainer-email: Fede Raimondo <f.raimondo@fz-juelich.de>, Synchon Mandal <s.mandal@fz-juelich.de>

junifer-0.0.8.dev189/docs/changes/newsfragments/502.bugfix

@@ -0,0 +1 @@
+Fix type issues and update model configs for :class:`.BaseDataGrabber`, :class:`.BasePreprocessor`, :class:`.BaseMarker` and :class:`.BaseStorage` by `Synchon Mandal`_

{junifer-0.0.8.dev184 → junifer-0.0.8.dev189}/junifer/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.0.8.dev184'
-__version_tuple__ = version_tuple = (0, 0, 8, 'dev184')
+__version__ = version = '0.0.8.dev189'
+__version_tuple__ = version_tuple = (0, 0, 8, 'dev189')
 
-__commit_id__ = commit_id = 'g32666e1bf'
+__commit_id__ = commit_id = 'g5e5ce7c0b'

{junifer-0.0.8.dev184 → junifer-0.0.8.dev189}/junifer/datagrabber/base.py

@@ -13,7 +13,7 @@ from typing import Annotated, Any
 
 import structlog
 from aenum import Enum as AEnum
-from pydantic import BaseModel, BeforeValidator, ConfigDict, Field
+from pydantic import BaseModel, BeforeValidator, ConfigDict
 
 from ..pipeline import UpdateMetaMixin
 from ..typing import Element, Elements
@@ -58,11 +58,10 @@ class BaseDataGrabber(BaseModel, ABC, UpdateMetaMixin):
 
     """
 
-    model_config = ConfigDict(use_enum_values=True)
+    model_config = ConfigDict(extra="forbid", use_enum_values=True)
 
     types: Annotated[
         DataType | list[DataType],
-        Field(frozen=True),
         BeforeValidator(ensure_list),
     ]
     datadir: Path

junifer-0.0.8.dev189/junifer/external/BrainPrint/.codecov.yml

@@ -0,0 +1,2 @@
+github_checks:
+  annotations: false

junifer-0.0.8.dev189/junifer/external/BrainPrint/.codespellignore

@@ -0,0 +1,2 @@
+coo
+daty

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,45 @@
+---
+name: Bug Report
+about: Create a bug report to help us improve BrainPrint
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Description
+<!-- A clear and concise description of the observed bug and/or error -->
+....
+
+## Steps to Reproduce
+<!-- 
+Steps to reproduce the observed behaviour, in as much detail as possible:
+1. Go to '...'
+2. Checkout version '...'
+3. Run '....'
+4. See error
+-->
+
+<!-- If possible, provide error messages, stack traces, and any snippets useful in describing the bug here -->
+...
+
+## Expected Behavior
+<!-- A clear and concise description of what you expected to happen. -->
+...
+
+## Screenshots
+<!-- If applicable and desired, add screenshots to help illustrate your problem. -->
+...
+
+## Environment
+ - BrainPrint Version: ...
+ - OS: ...
+ - CPU: ...
+
+<!-- Add any other relevant information on the environment here -->
+
+<!-- If possible, include a snapshot of the python software package versions you have (for e.g., using pip freeze or conda list) here -->
+
+## Additional Context
+<!-- Add any other context and comments about the problem here. -->
+...

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,12 @@
+---
+name: Documentation
+about: Report an issue or make a suggestion related to BrainPrint documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+## Documentation
+<!-- A clear and concise description of an issue you observed in the documentation, or a suggestion you wish to make. -->
+...

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,24 @@
+---
+name: Feature Request
+about: Submit a proposal/request for a new BrainPrint feature
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Feature Description
+<!-- A clear and concise description of the feature you would like to propose -->
+...
+
+## Motivation
+<!-- A clear and concise description of the problem that the proposed feature would address. For e.g., I'm always frustrated when [...]. If this is related to a specific issue, refer to it here -->
+...
+
+## Alternatives
+<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->
+...
+
+## Additional Context
+<!-- Add any other context or screenshots about the feature request here. -->
+...

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/ISSUE_TEMPLATE/questions-help-support.md

@@ -0,0 +1,28 @@
+---
+name: Questions/Help/Support
+about: Submit a request for support or a question
+title: ''
+labels: question
+assignees: ''
+
+---
+
+## Question/Support Request
+<!-- A clear and concise description of a question you may have or a problem for which you would like to request support  -->
+...
+
+## Screenshots
+<!-- If possible, add screenshots to help illustrate your problem. -->
+...
+
+<!-- If applicable, provide error messages, stack traces, and any snippets useful in describing your problem here -->
+
+## Environment
+ - BrainPrint Version: ...
+ - OS: ...
+ - CPU: ...
+
+<!-- Add any other relevant information on the environment here -->
+
+<!-- If possible, include a snapshot of the python software package versions you have (for e.g., using pip freeze or conda list) here -->
+

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/workflows/build.yml

@@ -0,0 +1,53 @@
+name: build
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+on:
+  pull_request:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build:
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos, windows]
+        python-version: [3.8, 3.9, "3.10", "3.11"]
+    name: ${{ matrix.os }} - py${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: 'x64'
+      - name: Install dependencies
+        run: |
+          python -m pip install --progress-bar off --upgrade pip setuptools wheel
+          python -m pip install --progress-bar off .[build]
+      - name: Test package install
+        run: brainprint-sys_info
+      - name: Remove package install
+        run: python -m pip uninstall -yq brainprint
+      - name: Build package
+        run: python -m build
+      - name: Install sdist
+        run: pip install ./dist/*.tar.gz
+      - name: Test sdist install
+        run: brainprint-sys_info
+      - name: Remove sdist install
+        run: python -m pip uninstall -yq brainprint
+      - name: Install wheel
+        run: pip install ./dist/*.whl
+      - name: Test wheel install
+        run: brainprint-sys_info
+      - name: Remove wheel install
+        run: python -m pip uninstall -yq brainprint

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/workflows/code-style.yml

@@ -0,0 +1,44 @@
+name: code-style
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+on:
+  pull_request:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  style:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+          architecture: 'x64'
+      - name: Install dependencies
+        run: |
+          python -m pip install --progress-bar off --upgrade pip setuptools wheel
+          python -m pip install --progress-bar off .[style]
+      - name: Run Ruff
+        run: ruff check .
+      - name: Run isort
+        uses: isort/isort-action@master
+      - name: Run black
+        uses: psf/black@stable
+        with:
+          options: "--check --verbose"
+          version: "23.10.1"
+      - name: Run codespell
+        uses: codespell-project/actions-codespell@master
+        with:
+          check_filenames: true
+          check_hidden: true
+          skip: './.git,./build,./.mypy_cache,./.pytest_cache'
+          ignore_words_file: ./.codespellignore
+      # - name: Run pydocstyle
+      #   run: pydocstyle .

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/workflows/doc.yml

@@ -0,0 +1,65 @@
+name: doc
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+on:
+  pull_request:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          path: ./main
+      - name: Setup Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+          architecture: 'x64'
+      - name: Install package
+        run: |
+          python -m pip install --progress-bar off --upgrade pip setuptools wheel
+          python -m pip install --progress-bar off main/.[doc]
+      - name: Display system information
+        run: brainprint-sys_info --developer
+      - name: Build doc
+        run: sphinx-build ./main/doc ./doc-build/dev -W --keep-going
+      - name: Upload documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: doc-dev
+          path: ./doc-build/dev
+
+  deploy:
+    if: github.event_name == 'push'
+    needs: build
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Download documentation
+        uses: actions/download-artifact@v4
+        with:
+          name: doc-dev
+          path: ./doc-dev
+      - name: Deploy dev documentation
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc-dev
+          destination_dir: ./dev
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: publish
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+jobs:
+  pypi:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+          architecture: 'x64'
+      - name: Install dependencies
+        run: |
+          python -m pip install --progress-bar off --upgrade pip setuptools wheel
+          python -m pip install --progress-bar off .[build]
+      - name: Display system information
+        run: brainprint-sys_info --developer
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN  }}
+        run: |
+          python -m build
+          twine upload dist/*

junifer-0.0.8.dev189/junifer/external/BrainPrint/.github/workflows/pytest.yml

@@ -0,0 +1,54 @@
+name: pytest
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+on:
+  pull_request:
+    paths:
+      - '**.py'
+  push:
+    branches: [main]
+    paths:
+      - '**.py'
+  workflow_dispatch:
+
+jobs:
+  pytest:
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos, windows]
+        python-version: [3.8, 3.9, "3.10", "3.11"]
+    name: ${{ matrix.os }} - py${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: 'x64'
+      - name: Install package
+        run: |
+          python -m pip install --progress-bar off --upgrade pip setuptools wheel
+          python -m pip install --progress-bar off .[test]
+      - name: Display system information
+        run: brainprint-sys_info --developer
+      - name: Run pytest
+        run: pytest brainprint --cov=brainprint --cov-report=xml --cov-config=pyproject.toml
+      - name: Upload to codecov
+        if: ${{ matrix.os == 'ubuntu' && matrix.python-version == 3.9 }}
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.xml
+          flags: unittests # optional
+          name: codecov-umbrella # optional
+          fail_ci_if_error: true # optional (default = false)
+          verbose: true # optional (default = false)
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: deep-mi/BrainPrint

junifer-0.0.8.dev189/junifer/external/BrainPrint/.gitignore

@@ -0,0 +1,123 @@
+# macOS
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+junit-results.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+doc/_build/
+doc/generated/
+doc/api/generated/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# PyCharm
+**/.idea/

junifer-0.0.8.dev189/junifer/external/BrainPrint/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Image Analysis, DZNE e.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

junifer-0.0.8.dev189/junifer/external/BrainPrint/README.md

@@ -0,0 +1,108 @@
+[![PyPI version](https://badge.fury.io/py/brainprint.svg)](https://pypi.org/project/brainprint/)
+# BrainPrint
+
+This is the `brainprint` python package, a derivative of the original
+[BrainPrint-legacy](https://github.com/Deep-MI/BrainPrint-legacy) scripts,
+with the primary goal to provide a Python-only version, to integrate the
+[LaPy](https://github.com/Deep-MI/LaPy) package, and to remove dependencies
+on third-party software (shapeDNA-* binaries, gmsh, meshfix). As a result,
+some functionality of the original BrainPrint-legacy scripts is no longer
+maintained (currently no support of tetrahedral meshes and no support of
+cortical parcellations or label files).
+
+## Installation
+
+Use the following code to install the latest release of LaPy into your local
+Python package directory:
+
+`python3 -m pip install brainprint`
+
+This will also install the necessary dependencies, e.g. the [LaPy](https://github.com/Deep-MI/LaPy)
+package. You may need to add your local Python package directory to your $PATH
+in order to run the scripts.
+
+## Usage
+### Command Line Interface (CLI)
+
+Once installed, the package provides a `brainprint` executable which can be run from the command line.
+
+The `brainprint` CLI enables per-subject computation of the individual brainprint descriptors. Its usage and options are summarized below;
+detailed info is available by calling the script without any arguments from the command line.
+
+```sh
+brainprint --sdir <directory> --sid <SubjectID>  [--num <num>] [--evec] [--skipcortex] [--norm <surface|volume|geometry|none> ] [--reweight] [--asymmetry] [--outdir <directory>] [--help] [--more-help]
+
+Options:
+  --help           Show this help message and exit
+  --more-help      Show extensive help message and exit
+
+Required options:
+  --sid <SubjectID>
+                   Subject ID (FreeSurfer-processed directory inside the
+                   subjects directory)
+  --sdir <directory>
+                   FreeSurfer subjects directory
+
+Processing directives:
+  --num <num>      Number of eigenvalues/vectors to compute (default: 50)
+  --evec           Switch on eigenvector computation (default: off)
+  --skipcortex     Skip cortical surfaces (default: off)
+  --norm <surface|volume|geometry|none>
+                   Switch on eigenvalue normalization; will be either surface,
+                   volume, or determined by the geometry of the object. Use
+                   "none" or leave out entirely to skip normalization.
+  --reweight       Switch on eigenvalue reweighting (default: off)
+  --asymmetry      Perform left-right asymmetry calculation (default: off)
+  --cholmod        Switch on use of (faster) Cholesky decomposition instead
+                   of (slower) LU decomposition (default: off). May require 
+                   manual install of scikit-sparse package. 
+
+Output parameters:
+  --outdir=OUTDIR  Output directory (default: <sdir>/<sid>/brainprint)
+  --keep-temp      Whether to keep the temporary files directory or not
+                   by default False
+```
+
+### Python Package
+
+`brainprint` can also be run within a pure Python environment, i.e. installed and imported as a Python package. E.g.:
+
+```python
+>>> from brainprint import Brainprint
+
+>>> subjects_dir = "/path/to/freesurfer/subjects_dir/"
+>>> subject_id = "42"
+
+>>> bp = Brainprint(subjects_dir=subjects_dir, asymmetry=True, keep_eigenvectors=True)
+>>> results = bp.run(subject_id=subject_id)
+>>> results
+{"eigenvalues": PosixPath("/path/to/freesurfer/subjects_dir/subject_id/brainprint/subject_id.brainprint.csv"), "eigenvectors": PosixPath("/path/to/freesurfer/subjects_dir/subject_id/brainprint/eigenvectors"), "distances": PosixPath("/path/to/freesurfer/subjects_dir/subject_id/brainprint/subject_id.brainprint.asymmetry.csv")}
+```
+
+## Output
+
+The script will create an output directory that contains a CSV table with
+values (in that order) for the area, volume, and first n eigenvalues per each
+FreeSurfer structure. An additional output file will be created if the
+asymmetry calculation is performed and/or for the eigenvectors (CLI `--evecs` flag or `keep_eigenvectors` on class initialization).
+
+## Changes
+
+There are some changes in functionality in comparison to the original [BrainPrint](https://github.com/Deep-MI/BrainPrint-legacy)
+scripts:
+
+- currently no support for tetrahedral meshes
+- currently no support for analyses of cortical parcellation or label files
+- no more Python 2.x compatibility
+
+## API Documentation
+
+The API Documentation can be found at https://deep-mi.org/BrainPrint .
+
+## References
+
+If you use this software for a publication please cite:
+
+[1] BrainPrint: a discriminative characterization of brain morphology. Wachinger C, Golland P, Kremen W, Fischl B, Reuter M. Neuroimage. 2015;109:232-48. http://dx.doi.org/10.1016/j.neuroimage.2015.01.032 http://www.ncbi.nlm.nih.gov/pubmed/25613439
+
+[2] Laplace-Beltrami spectra as 'Shape-DNA' of surfaces and solids. Reuter M, Wolter F-E, Peinecke N Computer-Aided Design. 2006;38:342-366. http://dx.doi.org/10.1016/j.cad.2005.10.011