Skip to content

servoz/populse_mia

 
 

Repository files navigation

populse_mia logo ©Johan Pietras @IRMaGe

Documentation

The documentation is available on populse_mia's website here: https://populse.github.io/populse_mia

Installation

  • From PyPI

  • From source, for Linux distributions

    • A compatible version of Python must be installed

    • Install a Version Control System, for example git. Depending of your distribution, package management system can be different

      sudo apt-get install git # Debian like
      sudo dnf install git # Fedora 22 and later
      # etc.
      
    • We use Git extension for versioning large files (Git LFS) of the populse_mia project. We therefore recommend to install git-lfs.

    • Clone the source codes

      • Get source codes from Github. Replace [mia_install_dir] with a directory of your choice

        git lfs clone https://github.com/populse/populse_mia.git [mia_install_dir]
        
      • Or download the zip file (populse_mia-master.zip) of the project (green button "Clone or download"), then extract the data in the directory of your choice [mia_install_dir]

         unzip populse_mia-master.zip -d [mia_install_dir]  # In this case [mia_install_dir] becomes [mia_install_dir]/populse_mia-master
        
    • Install the Python module distribution

      cd [mia_install_dir]  
      python3 setup.py install --user # Ensure that you use python >= 3.5 (use python3.x to be sure)  
      
    • To run populse_mia from the source code, don't remove it. Otherwise:

      cd ..  
      rm -r [mia_install_dir]  
      

Usage

  • For Linux: launching from the source code directory via command line

    • Interprets the main.py file

      cd [mia_install_dir]/python/populse_mia  
      python3 main.py  
      
  • For all platforms, after a Populse_MIA’s user installation

    python3 -m populse_mia
    
  • 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.11.3
    python3 -m pip install --force-reinstall PyQt5-sip==4.19.13
    

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

  • 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 [mia_install_dir])
    

Requirements

  • capsul
  • lark-parser
  • matplotlib
  • mia-processes
  • nibabel
  • nipype
  • pillow
  • populse-db
  • pyqt5
  • python-dateutil
  • pyyaml
  • scikit-image
  • scipy
  • SIP
  • sqlalchemy
  • 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
  • You can find all the details on the license here, or refer to the license file here

Support and Communication

If you have a problem or would like to ask a question about how to do something in populse_mia, please open an issue.

You can even contact the developer team by using populse-support@univ-grenoble-alpes.fr.

About

Multiparametric Image Analysis

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%