Documentation

The documentation is available on populse_mia's website here

Installation

• From PyPI, for users

• By cloning the package, for developers

• From source, to use the latest version of populse_mia

• Third-party software

• The populse project uses Git Large File Storage (LFS). In developer mode (without installing the source codes), after cloning the source codes, it is advisable to retrieve the large files with Git LFS:

  • If Git LFS is not already installed on your system, you need to install it first.

    • Ex. on Fedora:

      sudo dnf install git-lfs
      

  • Initialize Git LFS.

    • On a reposirory:

      git lfs install
      

  • Retrieve Files with Git LFS.

    • On a repository:

      git lfs pull
      

Usage

• After an installation in user mode:

  python3 -m populse_mia
  

• After an installation in developer mode, interprets the main.py file from the source code directory:

  cd [populse_install_dir]/populse_mia/populse_mia
  python3 main.py
  

• Depending on the operating system used, it was observed some compatibility issues with PyQt5/SIP. In this case, we recommend, as a first attempt, to do:

  python3 -m pip install --force-reinstall pyqt5==5.14.0
  python3 -m pip install --force-reinstall PyQt5-sip==5.0.1
  

• A minimal data set (~500 MB, zip file with Bruker, Philips and NIfTI data) can be downloaded here to allow users to quickly start using and testing Mia.

Contributing to the project

If you'd like to contribute to the project please read our developer documentation page. Please also read through our code of conduct.

Tests

• Unit tests written thanks to the python module unittest

• Continuous integration made with Travis (Linux, OSX), and AppVeyor (Windows)

• Code coverage calculated by the python module codecov

• The module is ensured to work with Python >= 3.9

• The module is ensured to work on the platforms Linux, OSX and Windows

• The script of tests is populse_mia/test.py, so the following command launches the tests:

  python3 populse_mia/test.py (from populse_mia root folder, for example [populse_install_dir]/populse_mia)
  

Requirements

• capsul >= 2.5.0, < 3.0.0
• cryptography
• matplotlib
• mia-processes >= 2.5.0, < 3.0.0
• nibabel
• nipype
• pillow
• populse-db >= 2.5.0, < 3.0.0
• pre-commit
• pyqt5
• python-dateutil
• pyyaml
• scikit-image
• scipy
• snakeviz
• soma-base >= 5.2.0, < 6.0.0
• soma-workflow >= 3.2.2
• six >= 1.13
• traits

Other packages used

• sphinx
• unittest

License

• The whole populse project is open source
• Populse_mia is precisely released under the CeCILL software license
• All license details can be found here, or refer to the license file here.

Support and Communication

All bugs, concerns and enhancement requests for populse_mia can be submitted here.

The developer team can even be contacted using [email protected].