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 Code style: black 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. (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/.

Metadata

Release files for junifer 0.0.6.dev478

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for junifer 0.0.6.dev478
File Size Uploaded
junifer-0.0.6.dev478.tar.gz 1.6 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for junifer 0.0.6.dev478
File Interpreter ABI Platform
junifer-0.0.6.dev478-py3-none-any.whl Python 3 none any Details

Total release size: 3.3 MB

Release files / junifer-0.0.6.dev478.tar.gz

Download URL junifer-0.0.6.dev478.tar.gz
Size 1.6 MB
Tags Source
SHA-256 checksum
How to use checksums
f7d2baabcf881bc009cabc0b43795482fceb77f1394573f322407fc96be0b4d1
BLAKE2b-256 checksum
How to use checksums
7d2cf21069f1ae30655504f3713694445c396cb4d6009b9fb4d9299557e850f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 17, 2025.

Transparency log

Release files / junifer-0.0.6.dev478-py3-none-any.whl

Download URL junifer-0.0.6.dev478-py3-none-any.whl
Size 1.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
58cdd83e3e378f221ba1b780c1acae1a34f511015c3861b00b6bfdc9ababeab3
BLAKE2b-256 checksum
How to use checksums
9fb0e191fd5456e7a2e123a75c9bcf646a1c5d080d7d4fd24a057cf40924b996
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 17, 2025.

Transparency log

Release history Release notifications | RSS feed

0.0.7

2 release files

0.0.6

2 release files

This release

0.0.6.dev478 This release

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page