Link Search Menu Expand Document

Tutorial

This page will walk you through the steps of creating a basic Minerva Story, with curated channel groups and narrated waypoints.

Before you start, it might be helpful to go over the Minerva Glossary to know some of the terms in this tutorial.

STEP 0 : Requirements

Check to make sure you have the following before you start authoring your story:

  1. You will need the path pointing to your OME-TIFF image
    • e.g. “C/Documents/Data/image_01.ome.tif”
    • This image can either be on your local computer or a mounted drive
  2. [Recommended] The path to a CSV file with marker names in one column
    • The header of the column should be marker_name. See an example marker_name.csv file.
    • Alternatively, you will need to know the marker names and order to add them manually.

No image data yet? No worries!

This example dataset contains a OME-TIFF and CSV marker file that you can use to follow this tutorial.


STEP 1: Download Minerva Author

instructions and links to download Minerva Author


STEP 2: Run Minerva Author

  • Unzip the downloaded file
  • Run the executable:
    • On Windows, double-click on the executable file minerva_author.exe.
    • On MacOS, right-click and “Open” the executable file minerva_author.

This will open a terminal on your computer and begin running the program A terminal automatically opens and displays text to indicate that Minerva Author is running.

It will also launch the program in your default browser. If your default browser not Firefox or Chrome, copy the URL from the address bar to Chrome or Firefox.

Minerva Author interface opens in the browser. The interface prompts the input of path to image or story file, optional marker_name.csv file and optional output name.

If the program does not automatically launch, then open a browser and enter localhost:2020 into the address bar


STEP 3: Import data

Select the OME-TIFF file you wish to create a Minerva Story for

Alternatively, if you have already started authoring a story want to return to it, select the .story.json file saved from the previous session.

*See the FAQ page for commonly encountered questions on importing .story.json file.

Select the CSV file with a list of marker names in the image

This file must be a .csv with the same format as the example.

If you start with .story.json, you do not need to provide a CSV file.

Enter an output name (e.g. LUNG-3-PR) for this story.

This string will be used in the output filenames. Avoid spaces and special characters. Underscores and dashes are ok.

*If you do not choose an optional output name, your story file will be named out.

Click “Import” and wait for the image to be loaded in your browser

*During this time, your image is being converted to smaller image tiles for faster viewing within the story. This step will take longer if your image is larger in file size.

Example inputs are shown on the Minerva Author interface. Path to image is '/Volumnes/Data/HMS/LUNG-3/LUNG-3-PR_40X.ome.tif'. Optional marker_name.csv is '/Volumes/Data/HMS/LUNG-3/channel_names.cvs'. Optional output name is 'LUNG-3-PR'.


STEP 4: Start authoring

Minerva uses Markdown to format text. This means that you can bold text by adding **around to your text** and italicize by adding *around your text*.

You can also add formating elements like headings, lists and tables with Markdown. For more Markdown basics, follow the link below.

Markdown Basics

4.1 Enter sample info

Begin by giving your sample a title and a description.

Minerva Author prompts user to enter sample title and description. Example sample title is 'Primary Lung Cancer'. Example description reads 'An interactive tour of a primary squamous cell carcinoma of lung and adjacent non-neoplastic tissue surgically resected from a 44 year old female patient.'.

This information will be displayed in the front page in the Minerva Story, along with a table of contents.

Sample title and description is shown on the first page of a finished Minerva story.

4.2 Create channel groups

A channel group is a predefined group of image channels and rendering settings (color, contrast, etc.) that will be displayed at each waypoint of the Minerva story and that the users can toggle between.

Click the “Add Group” button and enter a name for the channel group.

Tissue architecture is an example of a channel group name.

Then, select the channels you want to assign to the channel group.

A drop-down menu displays all available channels to add to the channel group.

Next, change the color for each channel.

User can choose the color for each channel by choosing the color directly from a spectrum or entering HEX or GRB code for the desired color.

Finish by adjusting the channel contrast using the slide bar.

Under each channel name, there is a slide bar for selecting the range of intensities to display.

Create as many channel groups as you would like. You can always come back to this tab to add more.

4.3 Create waypoints

Now it’s time to add narrative text and annotate the image. Select the “Edit Story” tab.

Start by selecting the channel group you want displayed at this waypoint. Dropdown menu displays two example channel groups, tissue architecture and macrophages, to choose from for this waypoint.

Then enter the title and narrative description for the waypoint.

  • When your Minerva Story is made public:
    • A colored underline will automatically appear when the marker name in the narrative description matches a marker in the currently active “channel groups” legend.
    • Optionally, you can add outgoing links on the marker names in the narrative description that lead to the GeneCard for the corresponding markers.

    See how to set up the links on the Frequently Asked Questions page.

As an example, the waypoint is titled Tissue Regions, and the description says 'In this tissue specifimen of human lung cancer, the tumor region can be seen on the right-hand side and an adjacent non-tumor, stromal region can be seen on the left-hand side.'

Add as many waypoints as you would like. You can change the zoom, pan, and add annotations such as boxes and arrows to the image.

  • Click the arrow icon arrow on the right of the control pane to create an arrow.
    • Then click anywhere on the image to place an arrow.
    • Click the name of the arrow at the bottom of the control pane to rename or rotate the arrow.
  • Click the crosshair icon region on the right of the control pane to make a rectangular outline for any region of interest.
    • Then click and drag anywhere on the image to place the outline.

Examples of the arrows and the rectangular region of interest created by the user are shown. The tip of the arrow points to where the user clicked, and the region of interest is outline in a white solid line.

4.4 Create optional data visualizations

Adding other ways to visualize data can help you tell a more complete story.

If you are not adding other data visualizations, simply skip to the next step.

Instructions to add data visualizations


STEP 5: Save and publish

Save

Periodically while writing your story, you’ll want to click the “Save” button to write your story’s progress to a file that can later be reopened in Minerva Author to continue writing your story.

Each time you save, Minerva Author will write to a .story.json file to store your waypoints and channel groups.

Publish and make your story public

Once you have completed authoring your story, click the “Publish” button to export a Minerva Story that’s ready to publish. You will see the progress bar reach 100% once it is done saving.

A list of expected outputs can be found here

To make your story visible to the public, you will need to host your image pyramids, index.html and story.json files.

There are many ways to do this. Here, we recommend using GitHub and GitHub Pages with the following steps.

5.1 Fork the example repository

View the example repository for Minerva Stories here

This create a copy of this repository under your account. GitHub has excellent documentation on how to fork a repository. You can follow their instructions here.

5.2 Upload your data and story files

The structure of the example repository mirrors the output you will recieve from Minerva Author.

Click Add File, upload your folder of image pyramids, index.html and story.json files to your repository, replacing the example files.

![Choose the Upload Files option under Add File]](/images/add-file-github.PNG)

5.3 Making your story public

You are nearly there!

Under Settings > Code and Automations > Pages, you can set the sources of your GitHub Page to main and display your site by clicking Save.

The option to set the source is under Branches. A dropdown menu displays available branches to choose from.

Your Minerva Story is ready to be viewed and shared! ✨