Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Junifer logo

junifer - JUelich NeuroImaging FEature extractoR

PyPI PyPI - Python Version PyPI - Wheel Anaconda-Server Badge GitHub Codecov Ruff pre-commit DOI FAIR checklist badge

About

junifer is a data handling and feature extraction library targeted towards neuroimaging data specifically functional MRI data.

It is currently being developed and maintained at the Applied Machine Learning group at Forschungszentrum Juelich, Germany. Although the library is designed for people working at Institute of Neuroscience and Medicine - Brain and Behaviour (INM-7), it is designed to be as modular as possible thus enabling others to extend it easily.

The documentation is available at https://juaml.github.io/junifer.

Repository Organization

  • docs: Documentation, built using sphinx.
  • examples: Examples, using sphinx-gallery. File names of examples that create visual output must start with plot_, otherwise, with run_.
  • junifer: Main library directory.
    • api: User API module.
    • configs: Module for pre-defined configs for most used computing clusters.
    • data: Module that handles data required for the library to work (e.g. parcels, coordinates).
    • datagrabber: DataGrabber module.
    • datareader: DataReader module.
    • external: Module for external libraries and tools.
    • markers: Markers module.
    • onthefly: Transformation components (on-the-fly) module.
    • pipeline: Pipeline module.
    • preprocess: Preprocessing module.
    • storage: Storage module.
    • testing: Testing components module.
    • typing: Type hints module.
    • utils: Utilities module (e.g. logging).

Installation

Use pip to install from PyPI like so:

pip install junifer

You can also install via conda, like so:

conda install -c conda-forge junifer

Optional dependencies

junifer supports a few optional dependencies to enable certain features. You can install them by specifying a comma separated list within square brackets, like so:

pip install "junifer[bct,dev]"
  • bct installs bctpy to enable use of onthefly module.
  • neurokit2 installs neurokit2 to enable use of complexity markers.
  • all includes all of the above.
  • dev installs packages needed for development.
  • docs installs packages needed for building documentation.

Citation

If you use junifer in a scientific publication, we would appreciate if you cite our work. Currently, we do not have a publication, so feel free to use the project's Zenodo URL.

Funding

We thank the Helmholtz Imaging Platform and SMHB for supporting development of junifer. Development of this software was funded, in part, by the European Union’s Horizon Europe Framework Programme for Research infrastructures under the specific grant agreement no. 101147319 (EBRAINS 2.0). (The funding sources had no role in the design, implementation and evaluation of the pipeline.)

Contribution

Contributions are welcome and greatly appreciated. Please read the guidelines to get started.

License

junifer is released under the AGPL v3 license:

junifer, FZJuelich AML neuroimaging feature extraction library. Copyright (C) 2023, authors of junifer.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

junifer-0.0.8.dev189.tar.gz (858.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

junifer-0.0.8.dev189-py3-none-any.whl (704.3 kB view details)

Uploaded Python 3

File details

Details for the file junifer-0.0.8.dev189.tar.gz.

File metadata

  • Download URL: junifer-0.0.8.dev189.tar.gz
  • Upload date:
  • Size: 858.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for junifer-0.0.8.dev189.tar.gz
Algorithm Hash digest
SHA256 4d204c8589a7b312eaf377c4a6a57f60848ac3430874aaff649ce7e1153cd489
MD5 a22a9752cc8553b6d0c00841c122f778
BLAKE2b-256 be19c4d780b99b89354dc012d7099e7d5cc6fadd85c0f588c475f7609d5aa1f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for junifer-0.0.8.dev189.tar.gz:

Publisher: publish.yml on juaml/junifer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file junifer-0.0.8.dev189-py3-none-any.whl.

File metadata

  • Download URL: junifer-0.0.8.dev189-py3-none-any.whl
  • Upload date:
  • Size: 704.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for junifer-0.0.8.dev189-py3-none-any.whl
Algorithm Hash digest
SHA256 bbc50b16a0fd964b3355278c12c9625de4fff42dc949967f44ad3f8a8f1c7abf
MD5 c93bc3bcd22697c2b2a7f256603ddae5
BLAKE2b-256 c2255235f92c41e65f3efe383466db5155b31bad305eb49d1f7ff31ca32115e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for junifer-0.0.8.dev189-py3-none-any.whl:

Publisher: publish.yml on juaml/junifer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.8.dev189 This release

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page