navigate Logo

Getting Started

  • Quick Start Guide
  • Software Installation
  • I Want To…

User Guide

  • Supported Hardware
  • Supported File Formats
  • User Interface Walkthrough
  • Setting Up A Microscope
  • Acquiring Data
  • Case Studies

Development

  • Contributing Guidelines
  • Developer Install
  • Software Architecture
  • Feature Container
  • REST-API
  • Plugin Architecture

Troubleshooting & Known Issues

  • Troubleshooting
  • Known Issues

Plugins

  • navigate Plugin Template
  • navigate Confocal Projection
  • navigate at Scale
  • navigate Constant Velocity Acquisition
  • navigate MMCore
  • navigate ilastik Server
  • navigate Photoactivation

Reference

  • Implemented Microscopes
  • Software API
    • navigate.config
    • navigate.controller
    • navigate.log_files
    • navigate.model
    • navigate.tools
      • navigate.tools.common_dict_tools
      • navigate.tools.common_functions
      • navigate.tools.decorators
      • navigate.tools.file_functions
        • navigate.tools.file_functions.create_save_path
        • navigate.tools.file_functions.delete_folder
        • navigate.tools.file_functions.get_ram_info
        • navigate.tools.file_functions.load_yaml_file
        • navigate.tools.file_functions.save_yaml_file
      • navigate.tools.image
      • navigate.tools.linear_algebra
      • navigate.tools.main_functions
      • navigate.tools.multipos_table_tools
      • navigate.tools.sdf
      • navigate.tools.slicing
      • navigate.tools.waveform_template_funcs
      • navigate.tools.xml_tools
    • navigate.view
navigate
  • Software API
  • navigate.tools
  • navigate.tools.file_functions
  • navigate.tools.file_functions.load_yaml_file
  • View page source

navigate.tools.file_functions.load_yaml_file

navigate.tools.file_functions.load_yaml_file(file_path: str) → Optional[dict]

Load YAML file from Disk

Parameters:

file_path (str) – String or path of the yaml file.

Returns:

config_data –

  • A dictionary/list of the yaml file content.

  • None: if the yaml file has error or not exist.

Return type:

dict/list/None

Previous Next

© Copyright 2025, Dean Lab, UT Southwestern Medical Center.