tiled

USAXS tiled data server: databroker and /share1 directory.

• tiled
  • Overview
  • Startup
    • Features
  • Additional content served
  • Links
  • Install
  • Files
    • bluesky.yml

Overview

Run the tiled data server for the USAXS beam line on workstation usaxscontrol. Since this server provides open access, it is only accessible within the APS subnet.

Startup

To start this tiled server (after configuring as described in the [Install](#install} section), navigate to this directory and run:

in-screen.sh

Then, use any web browser (within the APS firewall) to visit URL: http://THIS_WORKSTATION_NAME:8000.

The web interface is a simple UI demonstrating many features of the tiled server and also providing access to online documentation. Visit the documentation to learn how to build your own interface to tiled.

Features

• serve data from Bluesky databroker catalogs
• serve data from user experiment file directory

Additional content served

• Identify NeXus/HDF5 files with arbitrary names.
• Identify SPEC data files with arbitrary names and read them.
• Read .jpg (and other image format) files.
• Read the synApps MDA format (Python support)
• Write a custom data file identifier.
• Write a custom data file loader.
• Authentication
• Learn how to ignore files such as .xml (without startup comments).

Links

• bluesky/tiled#175
• https://blueskyproject.io/tiled/how-to/read-custom-formats.html#case-2-no-file-extension

Install

1. Setup and activate a custom micromamba (conda) environment as directed in environment.yml. (Do not expect that file needs editing as of 2022-11-23.)

   Note: This step defines a CONDA_PREFIX environment variable in the bash shell. Used below.

2. Edit tiled's configuration file: config.yml

   1. path is the name seen by the tiled clients.
   2. tree should not be changed
   3. for databroker catalogs, uri is the address of the mongodb catalog for this path
   4. for file directories, directory is the path to the directory. Either absolute or relative to the directory of this README.md file.

3. Edit bash starter shell script file start-tiled.sh

   1. Override definition of MY_DIR at your choice.
   2. Choose one definition of CONDA_ENV.

4. Edit web interface to display additional columns:

   1. In the $CONDA_PREFIX directory, edit file share/tiled/ui/config/bluesky.yml so it has the content indicated by the bluesky.yml below.

   2. Edit file share/tiled/ui/configuration_manifest.yml and add a line at the bottom to include the bluesky.yml file:

        - config/bluesky.yml

Files

bluesky.yml

specs:
  - spec: CatalogOfBlueskyRuns
    columns:
      - header: Bluesky Plan
        select_metadata: start.plan_name
        field: plan_name
      - header: Scan ID
        select_metadata: start.scan_id
        field: scan_id
      - header: Time
        select_metadata: start.time
        field: start_time
    default_columns:
      - plan_name
      - scan_id
      - start_time