Contents
Welcome to Microscope Automation’s documentation!¶
Hardware
Samples
Connectors
Utility
Import Helpers
Reference Docs
Microscope Automation¶
Automation software for a variety of popular microscopes, such as Zeiss and 3i.
Installation¶
To install the ZIP Version:
Copy the zip from the latest release
For ZEN systems, run Export_ZEN_COM_Objects.bat
You may have to run as an administrator for it to work properly.
Run
microscope_automation.exe
from inside the unzipped folder.
You can also use PyPI as follows:
Stable Release: pip install microscope_automation
Development Head: pip install git+https://github.com/aics-int/microscope_automation.git
Complete installation instructions available here.
Development¶
See CONTRIBUTING for information related to developing the code.
The Four Commands You Need To Know¶
pip install -e .[dev]
This will install your package in editable mode with all the required development dependencies (i.e.
tox
).make build
This will run
tox
which will run all your tests in both Python 3.7 and Python 3.8 as well as linting your code.make clean
This will clean up various Python and build generated files so that you can ensure that you are working in a clean environment.
make docs
This will generate and launch a web browser to view the most up-to-date documentation for your Python package.