From f50cef91b8e0f8f9668e032b8c694e1cffb01417 Mon Sep 17 00:00:00 2001 From: Talon Chandler Date: Thu, 3 Aug 2023 14:34:45 -0700 Subject: [PATCH 1/7] first-pass compatibility docs --- docs/meadowlark-software-upgrade.md | 9 +++++++++ docs/microscope-installation-guide.md | 24 ++++++++++++++++++++++-- 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 docs/meadowlark-software-upgrade.md diff --git a/docs/meadowlark-software-upgrade.md b/docs/meadowlark-software-upgrade.md new file mode 100644 index 00000000..22e126f5 --- /dev/null +++ b/docs/meadowlark-software-upgrade.md @@ -0,0 +1,9 @@ +# Upgrade Meadownlark PC software version + +To upgrade your "PC software version" use these steps: + +- From "Add and remove programs", remove CellDrive5000 and "National Instruments Software". +- From "Device manager", open the "Meadowlark Optics" group, right click `mlousb`, click "Uninstall device", check "Delete the driver software for this device", and click "Uninstall". Uninstall `Meadowlark Optics D5020 LC Driver` following the same steps. +- Using the USB stick provided by Meadowlark, reinstall the USB drivers and CellDrive5000. +- Confirm that "PC software version" == 1.08 +- **Upgrading users:** you will need to reinstall the Meadowlark device to your micromanager configuration file, because the device driver's name has changed to `MeadowlarkLC`. \ No newline at end of file diff --git a/docs/microscope-installation-guide.md b/docs/microscope-installation-guide.md index d54a00de..42490fe5 100644 --- a/docs/microscope-installation-guide.md +++ b/docs/microscope-installation-guide.md @@ -1,11 +1,31 @@ # Microscope Installation Guide This guide will walk through a complete recOrder installation consisting of: +1. Checking pre-requisites for compatibility. +2. Installing Meadowlark DS5020 and liquid crystals. 1. Installing and launching the latest stable version of `recOrder` via `pip`. 2. Installing a compatible version of `MicroManager` and LC device drivers. 3. Connecting `recOrder` to `MicroManager` via a `pycromanager` connection. -Before you start you will need a machine with Windows 10, a Meadowlark DS5020 connected to a liquid crystal device, and a microscope system compatible with `Micromanager`. +# Compatibility Summary +Before you start you will need to confirm that your system is compatible with the following software: + +| Software | Version | +| :--- | :--- | +| `recOrder` | 0.3.x | +| OS | Windows 10 | +| Micromanager version | [2022-09-20 (160 MB)](https://download.micro-manager.org/nightly/2.0/Windows/MMSetup_64bit_2.0.1_20220920.exe) | +| Meadowlark drivers | [recOrder-0.3.0-device-drivers.zip (112 kB)](https://github.com/mehta-lab/recOrder/releases/download/0.3.0/recOrder-0.3.0-device-drivers.zip) | +| Meadowlark PC software version | 1.04 | +| Meadowlark controller firmware version | >=1.04 | + +## Install Meadowlark DS5020 and liquid crystals + +Start by installing the Meadowlark DS5020 and liquid crystals using the software on the USB stick provided by Meadowlark. You will need to install the USB drivers and CellDrive5000. + +**Check your installation's versions** by opening CellDrive5000 and double clicking the Meadowlark Optics logo. Confirm that **"PC software version = 1.08" and "Controller firmware version = 1.04".** + +If you need to upgrade your Meadowlark Software, [follow these steps](./meadowlark-software-upgrade.md). ## Install recOrder software @@ -31,7 +51,7 @@ Install `Micromanager 2.0` nightly build `20220920` (https://micro-manager.org/M **Note:** We have tested recOrder with `20220920`, but most features will work with newer builds. We recommend testing a minimal installation with `20220920` before testing with a different nightly build or additional device drivers. -Before launching `Micromanager`, download the Meadowlark device adapters and calibration files from the [release page](https://github.com/mehta-lab/recOrder/releases/) and place these three unzipped files into your `Micromanager` folder (likely `C:\Program Files\Micro-Manager` or similar). +Before launching `Micromanager`, [download the Meadowlark device adapters and calibration files](https://github.com/mehta-lab/recOrder/releases/download/0.3.0/recOrder-0.3.0-device-drivers.zip) and place these three unzipped files into your `Micromanager` folder (likely `C:\Program Files\Micro-Manager` or similar). Launch `Micromanager`, open `Devices > Hardware Configuration Wizard...`, and add the `MeadowlarkLcOpenSource` device to your configuration. Confirm your installation by opening `Devices > Device Property Browser...` and confirming that `MeadowlarkLCOpenSource` properties appear. From 08a3977c63ce8fca86a856762a1612558ffb858e Mon Sep 17 00:00:00 2001 From: Talon Chandler Date: Thu, 3 Aug 2023 15:48:08 -0700 Subject: [PATCH 2/7] matching version numbers --- docs/microscope-installation-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/microscope-installation-guide.md b/docs/microscope-installation-guide.md index 42490fe5..fc22f55e 100644 --- a/docs/microscope-installation-guide.md +++ b/docs/microscope-installation-guide.md @@ -23,7 +23,7 @@ Before you start you will need to confirm that your system is compatible with th Start by installing the Meadowlark DS5020 and liquid crystals using the software on the USB stick provided by Meadowlark. You will need to install the USB drivers and CellDrive5000. -**Check your installation's versions** by opening CellDrive5000 and double clicking the Meadowlark Optics logo. Confirm that **"PC software version = 1.08" and "Controller firmware version = 1.04".** +**Check your installation's versions** by opening CellDrive5000 and double clicking the Meadowlark Optics logo. Confirm that **"PC software version = 1.04" and "Controller firmware version = 1.04".** If you need to upgrade your Meadowlark Software, [follow these steps](./meadowlark-software-upgrade.md). From 00348a97335690855baca3b221d1f4b0c3665579 Mon Sep 17 00:00:00 2001 From: Talon Chandler Date: Thu, 3 Aug 2023 15:52:42 -0700 Subject: [PATCH 3/7] Make MLO software upgrade independent of version --- docs/meadowlark-software-upgrade.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/meadowlark-software-upgrade.md b/docs/meadowlark-software-upgrade.md index 22e126f5..c41e1337 100644 --- a/docs/meadowlark-software-upgrade.md +++ b/docs/meadowlark-software-upgrade.md @@ -5,5 +5,4 @@ To upgrade your "PC software version" use these steps: - From "Add and remove programs", remove CellDrive5000 and "National Instruments Software". - From "Device manager", open the "Meadowlark Optics" group, right click `mlousb`, click "Uninstall device", check "Delete the driver software for this device", and click "Uninstall". Uninstall `Meadowlark Optics D5020 LC Driver` following the same steps. - Using the USB stick provided by Meadowlark, reinstall the USB drivers and CellDrive5000. -- Confirm that "PC software version" == 1.08 - **Upgrading users:** you will need to reinstall the Meadowlark device to your micromanager configuration file, because the device driver's name has changed to `MeadowlarkLC`. \ No newline at end of file From c208945e51088403550f9eee75dead5e426dd4bb Mon Sep 17 00:00:00 2001 From: Talon Chandler Date: Thu, 3 Aug 2023 15:53:41 -0700 Subject: [PATCH 4/7] fix numbering --- docs/microscope-installation-guide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/microscope-installation-guide.md b/docs/microscope-installation-guide.md index fc22f55e..565c533b 100644 --- a/docs/microscope-installation-guide.md +++ b/docs/microscope-installation-guide.md @@ -3,9 +3,9 @@ This guide will walk through a complete recOrder installation consisting of: 1. Checking pre-requisites for compatibility. 2. Installing Meadowlark DS5020 and liquid crystals. -1. Installing and launching the latest stable version of `recOrder` via `pip`. -2. Installing a compatible version of `MicroManager` and LC device drivers. -3. Connecting `recOrder` to `MicroManager` via a `pycromanager` connection. +3. Installing and launching the latest stable version of `recOrder` via `pip`. +4. Installing a compatible version of `MicroManager` and LC device drivers. +5. Connecting `recOrder` to `MicroManager` via a `pycromanager` connection. # Compatibility Summary Before you start you will need to confirm that your system is compatible with the following software: From 52138c106522e18c7a21997741d44d04141f7a3b Mon Sep 17 00:00:00 2001 From: Talon Chandler Date: Fri, 4 Aug 2023 09:09:44 -0700 Subject: [PATCH 5/7] h1 -> h2 --- docs/microscope-installation-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/microscope-installation-guide.md b/docs/microscope-installation-guide.md index 565c533b..1984690c 100644 --- a/docs/microscope-installation-guide.md +++ b/docs/microscope-installation-guide.md @@ -7,7 +7,7 @@ This guide will walk through a complete recOrder installation consisting of: 4. Installing a compatible version of `MicroManager` and LC device drivers. 5. Connecting `recOrder` to `MicroManager` via a `pycromanager` connection. -# Compatibility Summary +## Compatibility Summary Before you start you will need to confirm that your system is compatible with the following software: | Software | Version | From 9346fdbb02340daa8bca55ec0e1d8360d3d6e06a Mon Sep 17 00:00:00 2001 From: Talon Chandler Date: Fri, 4 Aug 2023 11:07:55 -0700 Subject: [PATCH 6/7] matching version constraints --- docs/microscope-installation-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/microscope-installation-guide.md b/docs/microscope-installation-guide.md index 1984690c..0a524ee9 100644 --- a/docs/microscope-installation-guide.md +++ b/docs/microscope-installation-guide.md @@ -23,7 +23,7 @@ Before you start you will need to confirm that your system is compatible with th Start by installing the Meadowlark DS5020 and liquid crystals using the software on the USB stick provided by Meadowlark. You will need to install the USB drivers and CellDrive5000. -**Check your installation's versions** by opening CellDrive5000 and double clicking the Meadowlark Optics logo. Confirm that **"PC software version = 1.04" and "Controller firmware version = 1.04".** +**Check your installation's versions** by opening CellDrive5000 and double clicking the Meadowlark Optics logo. Confirm that **"PC software version = 1.04" and "Controller firmware version >= 1.04".** If you need to upgrade your Meadowlark Software, [follow these steps](./meadowlark-software-upgrade.md). From 956f7f93ca2cfaa0567d1a5daf21c73dc0caab67 Mon Sep 17 00:00:00 2001 From: Talon Chandler Date: Sat, 5 Aug 2023 13:12:48 -0700 Subject: [PATCH 7/7] move PC software version instructions to installation guide; remove upgrade instructions --- docs/meadowlark-software-upgrade.md | 8 -------- docs/microscope-installation-guide.md | 5 ++++- 2 files changed, 4 insertions(+), 9 deletions(-) delete mode 100644 docs/meadowlark-software-upgrade.md diff --git a/docs/meadowlark-software-upgrade.md b/docs/meadowlark-software-upgrade.md deleted file mode 100644 index c41e1337..00000000 --- a/docs/meadowlark-software-upgrade.md +++ /dev/null @@ -1,8 +0,0 @@ -# Upgrade Meadownlark PC software version - -To upgrade your "PC software version" use these steps: - -- From "Add and remove programs", remove CellDrive5000 and "National Instruments Software". -- From "Device manager", open the "Meadowlark Optics" group, right click `mlousb`, click "Uninstall device", check "Delete the driver software for this device", and click "Uninstall". Uninstall `Meadowlark Optics D5020 LC Driver` following the same steps. -- Using the USB stick provided by Meadowlark, reinstall the USB drivers and CellDrive5000. -- **Upgrading users:** you will need to reinstall the Meadowlark device to your micromanager configuration file, because the device driver's name has changed to `MeadowlarkLC`. \ No newline at end of file diff --git a/docs/microscope-installation-guide.md b/docs/microscope-installation-guide.md index 0a524ee9..96ff5198 100644 --- a/docs/microscope-installation-guide.md +++ b/docs/microscope-installation-guide.md @@ -25,7 +25,10 @@ Start by installing the Meadowlark DS5020 and liquid crystals using the software **Check your installation's versions** by opening CellDrive5000 and double clicking the Meadowlark Optics logo. Confirm that **"PC software version = 1.04" and "Controller firmware version >= 1.04".** -If you need to upgrade your Meadowlark Software, [follow these steps](./meadowlark-software-upgrade.md). +If you need to change your PC software version, follow these steps: +- From "Add and remove programs", remove CellDrive5000 and "National Instruments Software". +- From "Device manager", open the "Meadowlark Optics" group, right click `mlousb`, click "Uninstall device", check "Delete the driver software for this device", and click "Uninstall". Uninstall `Meadowlark Optics D5020 LC Driver` following the same steps. +- Using the USB stick provided by Meadowlark, reinstall the USB drivers and CellDrive5000. ## Install recOrder software