The documentation is available on populse_mia's website here
From PyPI, for users
By cloning the package, for developers
From source, to use the latest version of populse_mia
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
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.
If you'd like to contribute to the project please read our developer documentation page. Please also read through our code of conduct.
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)
All bugs, concerns and enhancement requests for populse_mia can be submitted here.
The developer team can even be contacted using populse-support@univ-grenoble-alpes.fr.