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

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/python/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
  

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

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

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

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

Requirements

• capsul
• lark-parser
• matplotlib
• mia-processes
• nibabel
• nipype
• pillow
• populse-db
• pyqt5
• python-dateutil
• pyyaml
• scikit-image
• scipy
• SIP
• snakeviz
• soma_workflow
• traits

Other packages used

• copy
• os
• six
• tempfile
• 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

In case of a problem or to ask a question about how to do something in populse_mia, please open an issue.

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