ZEISS Microscopy Knowledge Base
Help
ZEISS Microscopy Knowledge Base

ZEN & ZEN core integration

Our ZEN connector allows you to use your arivis Cloud assets in ZEN & ZEN core.

To use your arivis Cloud assets on ZEN & ZEN core, you either need to:

Creating an access token (i.e., API key on arivis Cloud)

  1. Log into arivis Cloud.
  2. Navigate to the left panel and click on the three dots menu next to your name. Select My Access Tokens in the drop-down menu.
    Applications page showing 'Public Applications' and app cards 'Cell Confluency', 'Nuclei Counting', 'Cell Counting'; 'My Access Tokens' highlighted
  3. Click New Access Token.
    My Access Tokens page listing 'Access Token for ZEN instance segmentation' expiring in 339 days, status Active, and '+ New Access Token' button
  4. Provide a name, set the expiration date for your access token (i.e., API key), and click Next.
    New Access Token dialog with Name 'Demo token', Expires On '2023-06-22' and Next button
  5. Your access token (i.e., API key) is ready! Click on the button right next to your token to copy it. Make sure you copy the key right now. You will not be able to see it again. When you are done, click Finish.
    Personal token dialog showing token 'DD2q6IyAn9AJIngA-kxVwHOi2' and a warning to copy the API key now

Learn how to use your API token to use instance segmentation models in ZEN here.

Connecting ZEN core with your access token (i.e., API key)

  1. You created your access token (i.e., API key).
  1. Open the Maintenance tab in ZEN core and click on General Options.
    Three tiles labeled Free Mode, Browse Results, and Maintenance with corresponding icons
    Grid of option tiles including User Management, Archive Options, General Options and Manage Scaling
  2. Copy your personal token into the respective API key field of the APEER tab.
    Options dialog with APEER tab selected, visible API Key input and instructions to sign in to APEER

Downloading your (semantic) model

If you've trained a semantic segmentation model, you'll need to download it locally to your computer to use it in the software ecosystem, including ZEN and ZEN core.

  1. After your semantic training is complete on arivis Cloud, go to the left panel on your account and click on My Models to access your training results.
    Sidebar showing MACHINE LEARNING menu with Overview, My Datasets, My Models highlighted and teal arrow
  2. Find your model in the list on the My Models page, and click on it to view its details.
    My Models page with search box, 'Sort by date' menu and model list showing '723201 [version 1]' with dates
  3. To download the model, scroll down to the bottom of the page, click on Download ML Model and follow the instructions to select the correct model format.
    What else can I do? section with text about using APEER model and a Download ML Model button with teal arrow
  4. Once the download is complete, you can import the file into the software ecosystem, including ZEN and ZEN core.

That's it! Now you have the means to integrate your arivis Cloud assets with ZEN & ZEN core. Don't forget to explore more about how to use your models in the ZEISS ecosystem here.

Have questions? We're here to help.

Have a question about software ecosystem integration? Feel free to reach out to our support team.

Please contact ZEN core or ZEN if you have questions about their products.

Impressum
Carl-Zeiss-Strasse 22
73447 Oberkochen
Germany
Legal