Skip to main content

JUelich NeuroImaging FEature extractoR

Project description

Junifer logo

junifer - JUelich NeuroImaging FEature extractoR

PyPI PyPI - Python Version PyPI - Wheel GitHub Codecov

About

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

It is curently 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.
    • markers: Markers module.
    • pipeline: Pipeline module.
    • preprocess: Preprocessing module.
    • storage: Storage module.
    • testing: Testing components module.
    • utils: Utilities module (e.g. logging)

Installation

Use pip to install from PyPI like so:

pip install junifer

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 URL.

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) 2022, 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/.

Project details


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.1.dev37.tar.gz (598.9 kB view hashes)

Uploaded source

Built Distribution

junifer-0.0.1.dev37-py3-none-any.whl (441.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page