Installation

Preamble

PyMoDAQ-Femto is written in Python and uses Python 3.7+. It uses the Qt5 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.

On all platforms Windows, MacOS or Linux, Anaconda or Miniconda is the advised distribution/package manager. Environments can be created to deal with different version of packages and isolate the code from other programs. Anaconda comes with a full set of installed scientific python packages while Miniconda is a very light package manager.

Setting up a new environment

  • Download and install Miniconda3.

  • Open a console, and cd to the location of the condabin folder, for instance: C:\Miniconda3\condabin

  • Create a new environment: conda create -n my_env python=3.7, where my_env is your new environment name, could be pymodaq16 if you plan to install PyMoDAQ version 1.6.0 for instance.. This will create the environment with python version 3.7 that is currently the recommended one.

  • Activate your environment so that only packages installed within this environment will be seen by Python: conda activate my_env

  • Install, using conda manager, some mandatory packages: conda install pyqt

Installing PyMoDAQ-Femto

Easiest part: in your newly created and activated environment enter: pip install pymodaq_femto. This will install the latest PyMoDAQ-Femto available version and all its dependencies. For a specific version enter: pip install pymodaq_femto==x.y.z.

Creating shortcuts on Windows

Python packages can easily be started from the command line (see section_how_to_start). However, Windows users will probably prefer using shortcuts on the desktop. Here is how to do it (Thanks to Christophe Halgand for the procedure):

  • First create a shortcut (see Fig. 2) on your desktop (pointing to any file or program, it doesn’t matter)

  • Right click on it and open its properties (see Fig. 3)

  • On the Start in field (“Démarrer dans” in french and in the figure), enter the path to the condabin folder of your miniconda or anaconda distribution, for instance: C:\Miniconda3\condabin

  • On the Target field, (“Cible” in french and in the figure), enter this string: C:\Windows\System32\cmd.exe /k conda activate my_env & python -m pymodaq_femto.retriever. This means that your shortcut will open the windows’s command line, then execute your environment activation (conda activate my_env bit), then finally execute and start Python, opening the correct pymodaq_femto file (here retriever.py, starting the Retriever module, python -m pymodaq_femto.retriever bit)

  • You’re done!

  • Do it again for each PyMoDAQ-Femto’s module you want (to get the correct python file and it’s path, see run_module).

shortcut

Fig. 2 Create a shortcut on your desktop

shortcut properties

Fig. 3 Shortcut properties