TITLE: Getting started with  Micro-Meta App Tutorial
AUTHORS: Alessandro Rigano, Mathias Hammer, Joel Ryan, Claire M. Brown, David Grunwald, Caterina Strambio De Castillia

[DESCRIPTION]
For quality, interpretation, reproducibility, and sharing value,  microscopy images should be accompanied by detailed descriptions of the conditions that were used to produce them. Micro-Meta App is an intuitive, highly interoperable, open-source software tool that was developed in the context of the 4D Nucleome (4DN) consortium and is designed to facilitate the extraction and collection of relevant microscopy metadata as specified by the recent 4DN-BINA-OME  tiered-system of Microscopy Metadata specifications. In addition to substantially lowering the burden of quality assurance, the visual nature of the Micro-Meta App makes it particularly suited for training purposes.

In this protocol and in the associated videos (https://youtube.com/playlist?list=PLd2SsBj4SIsh7eE1M7l4v5_EsjUQcsfb0) you will learn how to get started using the Micro-Meta App for documenting your imaging experiments.

Want to learn more?
Please watch Video 1 of the Tutorial Series and read the publications listed in the References section of this protocol to learn more about the Micro-Meta App and the underlying 4DN-BINA-OME tiered system of Microscopy Metadata specifications.

[BEFORE_START]
In order to participate in this tutorial, you will need some prerequisites and materials that are described in the Materials section of this protocol.
In particular, before you start you will need to download the following example metadata files:
Microscope.JSON file: A file that contains a description of the hardware components of an example microscope.
Settings.JSON file: A file that contains a description of the settings that were used to acquire the example image data file.
Raw-image data file: An image data file that was acquired using the hardware specifications and acquisition settings described in the Microscope.JSON and Settings.JSON files.


[GUIDELINES]
These instructions are designed to help you best take advantage of a series of video Tutorials that were developed to help you get started using Micro-Meta App to document imaging experiments. You can find these video Tutorials on YouTube at the following link: https://youtube.com/playlist?list=PLd2SsBj4SIsh7eE1M7l4v5_EsjUQcsfb0


Need help?
Please contact us at:
Caterina Strambio De Castillia (caterina.strambio@umassmed.edu)
Alex Rigano (alex.rigano@umassmed.edu)

[STEPS]
SECTION: Before the tutorial
1. Video introduction


 

 

 

 


SECTION: Tutorial - 1 - Download and Install Micro-Meta App
2. Download Micro-Meta App

Follow the instructions in this step and in Video 3 of the tutorial series to download and install the stand-alone version of the Micro-Meta App.

 

SECTION: Tutorial - 1 - Download and Install Micro-Meta App
2.1. Click on this link to access the Download page
https://github.com/WU-BIMAC/MicroMetaApp-Electron/releases/latest
SECTION: Tutorial - 1 - Download and Install Micro-Meta App
2.2. Download and save ZIP file
Once you are on the download page please navigate to the bottom page and identify the ZIP file that is best suited for your operating system. 
"Right-click" on the link and select "Save Link As..."
Save the ZIP file to the "MMA Tutorial" folder you have created to save the example metadata files (see the instructions that are found in the Materials section of this protocol). 
SECTION: Tutorial - 1 - Download and Install Micro-Meta App
2.3. Unarchive the ZIP file and launch Micro-Meta App
Unarchive the ZIP file by following the instructions that are appropriate for your operating system.
 

 

SECTION: Tutorial - 1 - Download and Install Micro-Meta App
2.4. Launch Micro-Meta App
Launch the Micro-Meta App by following the instructions that are appropriate for your operating system.
 

SECTION: Tutorial - 2 - Manage Instrument
3. Manage Instrument
In this section of the tutorial, you will learn how to use the Manage Instrument functionality of Micro-Meta App to open an existing Microscope.JSON file and to create a simple new Microscope.JSON file from scratch.

To learn more about the Tier system of Microscopy Metadata used as the basis of Micro-Meta App please read the following publication:
 

SECTION: Tutorial - 2 - Manage Instrument
3.1. Open and inspect an existing Microscope.JSON file
In this part of the tutorial, you will learn how to open and inspect an existing Microscope.JSON file to evaluate its content and decide whether it needs further editing. 
To get started follow these steps:
Launch Micro-Meta App as described   
Click on "Continue".
Click on “Manage Instrument”.
Click on "Tier 3".
Click on “Import from file”, select the example Microscope.JSON file downloaded above and click on "Continue".
Follow the instructions in Video 4 of the Tutorial series to explore the hardware specifications metadata contained in the example Microscope.JSON file.

  
SECTION: Tutorial - 2 - Manage Instrument
3.2. Create a new Microscope.JSON file from scratch
In this part of the tutorial, you will learn how to create a new Microscope.JSON file that describes a Tier 1 microscope that is only used for qualitative or simple quantitative experiments.
To get started follow the steps hereinafter:
Launch Micro-Meta App as described   
Click on "Continue".
Click on “Manage Instrument”.
Click on "Tier 3".
Click on “Create Inverted from scratch” ,  and click on "Continue".
Follow the instructions in Video 5 of the tutorial series to add the following hardware components to the Microscope canvas and enter the hardware specifications listed in the specification files found following the links listed below:
            → Microscope Stand → Zeiss Axio-Observer
            → Light Source →  491 nm Laser
            → Objective → Zeiss PlanApo 63x/1.4
            → Filter Set → Multiband laser filter set, optimized for 488 & 561 nm laser sources
                   ○ Excitation Filter
                   ○ Emission Filter
                   ○ Dichroic beamsplitter
             → Detector → EMCCD camera

    

SECTION: Tutorial - 3 - Manage Settings
4. Manage Settings
In this section of the tutorial, you will learn how to use the Manage Settings functionality of theMicro-Meta App to open an existing Settings.JSON file, inspect its content and add a missing transmitted light Channel.
SECTION: Tutorial - 3 - Manage Settings
4.1. Open and inspect an existing Settings.JSON file
In this part of the tutorial, you will learn how to open and inspect an existing Settings.JSON file to evaluate its content and decide whether it needs further editing.
Launch Micro-Meta App as described   
Click on "Continue".
Click on “Manage Settings.
Click on "Tier 3".
Click on “Import from file” select the example Microscope.JSON file downloaded above and click on "Continue".
Click on “Import from file”, select the example image data file downloaded above and click on "Continue".
Click on “Import from file” , select the example Settings.JSON file downloaded above and click on "Continue".
Follow the instructions in Video 6 of the tutorial series to explore the image acquisition metadata contained in the example Settings.JSON file.

 
SECTION: Tutorial - 3 - Manage Settings
4.2.  Add an additional transmitted light Channel to an existing Settings.JSON file
Follow the steps described here   
Click on "Edit Channels".
Click on the "+" button, click on "Channel 3", and click on "Edit selected".
Follow the instructions in Video 7 of the tutorial series to enter information about a new transmittance light Channel in an existing Settings.JSON file.

  

SECTION: After the tutorial
5. Provide feedback
After testing the Micro-Meta App, we would love to have your feedback. 
Please fill in the survey by clicking here
SECTION: After the tutorial
6. Want to learn more?
Please read the publications and consult the resources listed below to learn more about Micro-Meta App, the underlying 4DN-BINA-OME tiered system of Microscopy Metadata specifications, and related metadata collection tools.
SECTION: After the tutorial
6.1. Community-driven 4DN-BINA-OME (NBO) Microscopy Metadata Specifications
To learn more about the 4DN-BINA-OME tiered system of Microscopy Metadata specifications that underlies the Micro-Meta App please consult the resources below:

 


 

 



SECTION: After the tutorial
6.2. Micro-Meta App
To learn more about the Micro-Meta App please consult the resources below:

 


 

 


SECTION: After the tutorial
6.3. Other metadata collection tools
To learn more about other interoperable metadata collection tools please consult the resources below:

 

 

 

 


SECTION: After the tutorial
7. Get more involved
If you want to get more involved and help us with developing or testing Micro-Meta App please join us by joining the QUAREP-LiMi Working Group WG7 on Metadata by clicking on the link below:
https://quarep.org/members/become-a-member/