nlScript-microscope-language 0.1.0

Use nlScript to develop a language based on natural English syntax to control microscope acquisition pipelines.

nlScript microscope language

A natural language for configuring complex microscope timelapse experiments, based on nlScript.

Even on modern microscopes, time-lapse experiments are often limited to data acquisition at fixed intervals. At each time point, images are acquired at a fixed number of planes, at fixed stage positions, possibly repeated for a fixed set of channels. The dynamic nature of biological processes often requires a more flexible imaging pipeline to be observed optimally, e.g., with the imaging interval adapted to the rate of change, with different channels imaged at varying intervals, or with different positions imaged with varying magnification. The hardware of modern microscope allows for such a flexibility, the limiting factor is the software. The reasons for this is the effort needed to design and develop a user interface that is intuitive and yet allows to configure such a flexible imaging experiment.

To address this gap, we have developed a language for describing flexible time-lapse imaging experiments on microscopes. While our language has been developed for the Zeiss Celldiscoverer 7, it is easily adaptable to other microscope modalities. Remarkably, only a few sentence templates are sufficient to configure time-lapse experiments that (i) provide flexible intervals, (ii) select positions and channels at each time point, (iii) adopt magnification, (iv) adopt channel settings such as laser power, (v) provide adjustable environmental settings (temperature and CO2 concentration).

More information about how to use nlScript to develop custom natural language interfaces can be found here:

• https://nlScript.github.io/nlScript-java
• https://github.com/nlScript/nlScript-java

You can interactively try the language at https://nlScript.github.io/nlScript-microscope-language-js.

Installation

• Install Python >=3.10 (including pip and venv)

• Optional: create a virtual environment:

  cd path/to/this/repository-folder
  python -m venv env
  

• If you created a virtual environment, activate it. On Windows, using Git Bash, e.g.

  source env/Scripts/activate
  

• Install nlScript-microscope-language:

  pip install nlScript-microscope-language
  

• Run it:

  nlScript-microscope-language 
  

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.