Skip to content

Quick Start

This walkthrough takes you from launching the GUI to viewing your first results. For detailed explanations of each step, see the User Guide.

1. Launch the GUI

conda activate morphometrics
morphometrics gui

Starting GUI

2. Create an experiment

In the experiment manager panel (right side):

  1. Set a Work Directory — where experiment folders will be created
  2. Enter an Experiment Name
  3. Select your Data Directory — the folder with your segmentation files
  4. Choose a Config Template — a YAML file from the surface_morphometrics directory

    Config template location matters

    The GUI detects analysis scripts based on where your config template is located. Keep your config template inside the surface_morphometrics directory (the repository containing the pipeline scripts). If you move it elsewhere, the GUI will not find the scripts.

  5. Set the number of Cores for parallel processing

  6. Review the Segmentation Values populated from the template
  7. Click New Experiment

Experiment Manager

3. Generate surface meshes

Switch to the Mesh Generation tab:

  1. Review the mesh generation settings
  2. Click Run to generate surface meshes from your segmentations

Mesh Generation

4. Run curvature analysis

Switch to the PyCurv tab:

  1. Select the VTP files to analyze (or use Select All)
  2. Click Run to compute curvature measurements

PyCurv

5. Measure distances and orientations

Switch to the Distance & Orientation tab:

  1. Configure intra-membrane and inter-membrane measurement pairs
  2. Click Run to compute distances and orientations

Distance & Orientation

6. Visualize results

Use the visualization panel on the left side to:

  • Preview your dataset with the tomogram slice viewer
  • Load and rotate meshes in 3D
  • Color surfaces by curvature, distance, or other properties
  • Load protein structures onto meshes

Next steps

See the User Guide for detailed explanations of each step, including configuration options and tips for getting the best results.