Installation

Overview

PyMoDAQ is written in Python and uses Python 3.5+. It uses the PyQt5 library and the excellent pyqtgraph package for its user interface. For PyMoDAQ to run smoothly, you need a Python distribution to be installed. Here are some advices.

Windows

The advised distribution is WinPython (WinPython64-3.7.1.0 tested to be working) that comes with a full set of python packages for a versatile use of python. For best practice, install it on the C drive, for instance: C:\WPy-3710 Once the distribution installed, you can install PyMoDAQ from the folder downloaded on github or from Pypi.

Using Pip:

Pymodaq can be downloaded and installed automatically using the command line tool: pip

  • get winpython and install it (choose a destination folder on C:\ directly, for instance C:\WPy-3710
  • open Winpython command line tool C:\WPy-3710\WinPython Command Prompt.exe
  • write the command: C:\WPy-3710\scripts\pip install pymodaq

All the modules will then be installed within the site-packages folder of python. Look at How to Start for detailed ways of how to start pymodaq modules.

Step by Step manual instructions:

  • get winpython and install it (choose a destination folder on C:\ directly, for instance C:\WPy-3710
  • download the source file from github or Pypi
  • Extract the archive (zip or tar file)
  • open Winpython command line tool C:\WPy-3710\WinPython Command Prompt.exe
  • cd to the location of the extracted archive: cd C:\...\pymodaq\
  • run: python setup.py install

All the modules will then be installed within the site-packages folder of python. .exe files will also be installed in the directory: C:\WPy-3710\python-3.7.1.amd64\Scripts so that you can run directly:

  • pymodaq_scan.exe : will start the DAQ Scan module
  • pymodaq_move.exe : will start a standalone DAQ Move module
  • pymodaq_viewer.exe : will start a standalone DAQ Viewer module
  • pymodaq_h5browser.exe : will start a standalone H5Browser module (to explore h5 files saved from DAQ_Scan or DAQ_Viewer modules)

MacOS

The advised distribution is Anaconda that comes with a full set of python packages for a versatile use of python. Once the distribution installed, you can follow the Windows instructions above (but using anaconda command line).

Linux

The advised distribution is Anaconda that comes with a full set of python packages for a versatile use of python. Once the distribution installed, you can follow the Windows instructions above (but using anaconda command line).