pyminflux 0.1.2

Reader, processor, and viewer of MINFLUX raw data.

   pyMINFLUX

Reader, analyzer, and viewer of MINFLUX raw data.

Installation

Apps

Compiled executables (apps) for Linux, macOS and Windows can be downloaded from the release page.

Please note: since pyMINFLUX on macOS comes from an unidentified developer, you might need to make an exception in the macOS security settings when launching it for the first time. To do this, right-click on the application icon and select Open. After this initial setup, you can simply double-click the icon to launch pyMINFLUX normally.

pip

The latest version of pyMINFLUX can also be installed from pypi.org. pyMINFLUX is compatible with and tested on Python 3.10 and 3.11. It is recommended to install pyMINFLUX in a conda environment as follows:

$ conda create -n pyminflux-env python=3.10  # or 3.11
$ conda activate pyminflux-env
$ pip install --upgrade pyminflux

pyMINFLUX can then easily be run from the command line:

$ pyminflux

For developers and tinkerers

pyMINFLUX is compatible with and tested on Python 3.10 and 3.11. For development, it is recommended to install pyMINFLUX in editable mode in a conda environment as follows:

Windows and Linux

$ conda create -n pyminflux-env python=3.10  # or 3.11
$ conda activate pyminflux-env
$ git clone https://github.com/bsse-scf/pyMINFLUX /path/to/pyminflux
$ cd /path/to/pyminflux
$ python -m pip install -e .

macOS

openGL support in recent macOS requires pyopengl to be installed with conda instead of pip.

$ conda create -n pyminflux-env python=3.10  # or 3.11
$ conda activate pyminflux-env
$ git clone https://github.com/bsse-scf/pyMINFLUX /path/to/pyminflux
$ cd /path/to/pyminflux
$ conda install pyopengl       # This is specific to macOS
$ python -m pip install -e .

Running pyMinFlux from console

$ cd /path/to/pyminflux
$ python pyminflux/main.py

Official website and documentation

The official pyMINFLUX website is on https://pyminflux.ethz.ch.

Citing pyMINFLUX

If you use pyMINFLUX in your research, please cite this repository as follows:

Aaron Ponti, Javier Casares Arias, & Thomas Horn. (2023). pyMINFLUX (0.1.1). Zenodo.