Metadata-Version: 2.1
Name: microscope-automation
Version: 0.3.3
Summary: Automation software for the AICS Microscopes.
Home-page: https://github.com/aics-int/microscope_automation
Author: Allen Institute for Cell Science
Author-email: fletcher.chapin@alleninstitute.org
License: Allen Institute Software License
Keywords: microscope_automation
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Free for non-commercial use
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: tifffile (<2021,>=2020.8.25)
Requires-Dist: aicsimageio (<3.4,>=3.2.3)
Requires-Dist: pandas (<1.3,>=1.1.1)
Requires-Dist: numpy (<1.20,>=1.19.1)
Requires-Dist: pyyaml (<5.4,>=5.3.1)
Requires-Dist: pyqtgraph (<0.12,>=0.11.0)
Requires-Dist: PyQt5 (<5.16,>=5.12.3)
Requires-Dist: matplotlib (<3.4,>=3.3.1)
Requires-Dist: formlayout (<1.3,>=1.2.0)
Requires-Dist: lxml (<4.7,>=4.5.2)
Requires-Dist: psutil (<5.9,>=5.8.0)
Requires-Dist: pyserial (<3.5,>=3.4)
Requires-Dist: scikit-image (<0.19,>=0.16.2)
Requires-Dist: scipy (<1.7,>=1.6.0)
Requires-Dist: pywin32 (<301,>=227) ; platform_system == "Windows"
Provides-Extra: all
Requires-Dist: tifffile (<2021,>=2020.8.25) ; extra == 'all'
Requires-Dist: aicsimageio (<3.4,>=3.2.3) ; extra == 'all'
Requires-Dist: pandas (<1.3,>=1.1.1) ; extra == 'all'
Requires-Dist: numpy (<1.20,>=1.19.1) ; extra == 'all'
Requires-Dist: pyyaml (<5.4,>=5.3.1) ; extra == 'all'
Requires-Dist: pyqtgraph (<0.12,>=0.11.0) ; extra == 'all'
Requires-Dist: PyQt5 (<5.16,>=5.12.3) ; extra == 'all'
Requires-Dist: matplotlib (<3.4,>=3.3.1) ; extra == 'all'
Requires-Dist: formlayout (<1.3,>=1.2.0) ; extra == 'all'
Requires-Dist: lxml (<4.7,>=4.5.2) ; extra == 'all'
Requires-Dist: psutil (<5.9,>=5.8.0) ; extra == 'all'
Requires-Dist: pyserial (<3.5,>=3.4) ; extra == 'all'
Requires-Dist: scikit-image (<0.19,>=0.16.2) ; extra == 'all'
Requires-Dist: scipy (<1.7,>=1.6.0) ; extra == 'all'
Requires-Dist: black (>=19.10b0) ; extra == 'all'
Requires-Dist: codecov (>=2.1.4) ; extra == 'all'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'all'
Requires-Dist: flake8-debugger (>=3.2.1) ; extra == 'all'
Requires-Dist: pytest (>=5.4.3) ; extra == 'all'
Requires-Dist: pytest-cov (>=2.9.0) ; extra == 'all'
Requires-Dist: pytest-raises (>=0.11) ; extra == 'all'
Requires-Dist: pytest-runner (>=5.2) ; extra == 'all'
Requires-Dist: pytest-html (>=2.1.1) ; extra == 'all'
Requires-Dist: mock (>=4.0.2) ; extra == 'all'
Requires-Dist: bumpversion (>=0.6.0) ; extra == 'all'
Requires-Dist: coverage (>=5.1) ; extra == 'all'
Requires-Dist: ipython (>=7.15.0) ; extra == 'all'
Requires-Dist: pyinstaller (>=4.0) ; extra == 'all'
Requires-Dist: Sphinx (<3.5,>=3) ; extra == 'all'
Requires-Dist: sphinx-rtd-theme (<0.6,>=0.4.3) ; extra == 'all'
Requires-Dist: tox (>=3.15.2) ; extra == 'all'
Requires-Dist: twine (>=3.1.1) ; extra == 'all'
Requires-Dist: wheel (>=0.34.2) ; extra == 'all'
Requires-Dist: pywin32 (<301,>=227) ; (platform_system == "Windows") and extra == 'all'
Provides-Extra: dev
Requires-Dist: black (>=19.10b0) ; extra == 'dev'
Requires-Dist: codecov (>=2.1.4) ; extra == 'dev'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'dev'
Requires-Dist: flake8-debugger (>=3.2.1) ; extra == 'dev'
Requires-Dist: pytest (>=5.4.3) ; extra == 'dev'
Requires-Dist: pytest-cov (>=2.9.0) ; extra == 'dev'
Requires-Dist: pytest-raises (>=0.11) ; extra == 'dev'
Requires-Dist: pytest-runner (>=5.2) ; extra == 'dev'
Requires-Dist: pytest-html (>=2.1.1) ; extra == 'dev'
Requires-Dist: mock (>=4.0.2) ; extra == 'dev'
Requires-Dist: bumpversion (>=0.6.0) ; extra == 'dev'
Requires-Dist: coverage (>=5.1) ; extra == 'dev'
Requires-Dist: ipython (>=7.15.0) ; extra == 'dev'
Requires-Dist: pyinstaller (>=4.0) ; extra == 'dev'
Requires-Dist: Sphinx (<3.5,>=3) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (<0.6,>=0.4.3) ; extra == 'dev'
Requires-Dist: tox (>=3.15.2) ; extra == 'dev'
Requires-Dist: twine (>=3.1.1) ; extra == 'dev'
Requires-Dist: wheel (>=0.34.2) ; extra == 'dev'
Provides-Extra: setup
Provides-Extra: test
Requires-Dist: black (>=19.10b0) ; extra == 'test'
Requires-Dist: codecov (>=2.1.4) ; extra == 'test'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'test'
Requires-Dist: flake8-debugger (>=3.2.1) ; extra == 'test'
Requires-Dist: pytest (>=5.4.3) ; extra == 'test'
Requires-Dist: pytest-cov (>=2.9.0) ; extra == 'test'
Requires-Dist: pytest-raises (>=0.11) ; extra == 'test'
Requires-Dist: pytest-runner (>=5.2) ; extra == 'test'
Requires-Dist: pytest-html (>=2.1.1) ; extra == 'test'
Requires-Dist: mock (>=4.0.2) ; extra == 'test'

*********************
Microscope Automation
*********************

.. image::
   https://github.com/aics-int/microscope_automation/workflows/Build%20Master/badge.svg
   :height: 30
   :target: https://github.com/aics-int/microscope_automation/actions
   :alt: Build Status

.. image::
   https://github.com/aics-int/microscope_automation/workflows/Documentation/badge.svg
   :height: 30
   :target: https://aics-int.github.io/microscope_automation
   :alt: Documentation

.. image::
   https://codecov.io/gh/aics-int/microscope_automation/branch/master/graph/badge.svg
   :height: 30
   :target: https://codecov.io/gh/aics-int/microscope_automation
   :alt: Code Coverage

Automation software for a variety of popular microscopes, such as Zeiss and 3i.

Installation
============
To install the ZIP Version:

1. Copy the zip from the `latest release <https://github.com/aics-int/microscope_automation/releases/>`_

2. For ZEN systems, run `Export_ZEN_COM_Objects.bat <https://github.com/aics-int/microscope_automation/blob/master/scripts/Export_ZEN_COM_Objects.bat>`_

  a. You may have to run as an administrator for it to work properly.

3. 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 <https://aics-int.github.io/microscope_automation/installation.html/>`_.

Development
===========
See `CONTRIBUTING <https://github.com/aics-int/microscope_automation/blob/master/CONTRIBUTING.rst/>`_
for information related to developing the code.

The Four Commands You Need To Know
==================================

1. ``pip install -e .[dev]``

    This will install your package in editable mode with all the required development
    dependencies (i.e. ``tox``).

2. ``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.

3. ``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.

4. ``make docs``

    This will generate and launch a web browser to view the most up-to-date
    documentation for your Python package.

Legal Documents
===============

- `LICENSE <https://github.com/aics-int/microscope_automation/blob/master/LICENSE.txt/>`_
- `CONTRIBUTING <https://github.com/aics-int/microscope_automation/blob/master/CONTRIBUTING.rst/>`_


