UPXO: UKAEA Poly-XTAL Operations

User Guide

  • Introduction
  • Getting Started
  • Key Concepts
  • Workflows

API Reference

  • upxo package
    • Module contents
    • Subpackages
      • upxo.algorithms package
      • upxo.analysis package
      • upxo.charops package
      • upxo.connops package
      • upxo.dclasses package
      • upxo.external package
      • upxo.flags_and_controls package
      • upxo.gbops package
      • upxo.geoEntities package
      • upxo.ggrowth package
      • upxo.grids package
      • upxo.gsContainters package
      • upxo.gsdataops package
      • upxo.heirGs package
      • upxo.imageOps package
      • upxo.interfaces package
        • Subpackages
        • Module contents
      • upxo.jpops package
      • upxo.material package
      • upxo.mechanics package
      • upxo.meshing package
      • upxo.misc package
      • upxo.netops package
      • upxo.parswep package
      • upxo.propOps package
      • upxo.pxtal package
      • upxo.pxtalops package
      • upxo.repgen package
      • upxo.repqual package
      • upxo.statops package
      • upxo.surrModelOps package
      • upxo.tempops package
      • upxo.topOps package
      • upxo.uiOps package
      • upxo.viz package
      • upxo.xtal package
      • upxo.xtalops package
      • upxo.xtalphy package
    • Submodules
UPXO: UKAEA Poly-XTAL Operations
  • upxo package
  • upxo.interfaces package
  • upxo.interfaces.os package
  • View page source

upxo.interfaces.os package

Submodules

  • upxo.interfaces.os.osops module
    • get_file_path()
    • get_path_UPXOsrcDIR()
    • get_path_UPXOdataDIR()
    • get_path_UPXODIR_L1()
    • get_path_UPXOwriterdataDIR()
    • load_file()
    • load_files()
    • find_n_to_targetDIR()
    • error_handler()
    • data_importer()
    • data_exporter()
    • FileManager
      • FileManager.create_folder()
      • FileManager.delete_folder()
      • FileManager.list_folder_contents()
      • FileManager.write_to_file()
      • FileManager.read_from_file()
      • FileManager.import_txt()
      • FileManager.import_csv()
      • FileManager.export_csv()
  • upxo.interfaces.os.package_check module
  • upxo.interfaces.os.pck_mgmt module
    • check_and_install_packages()
    • install_package()

Module contents

Previous Next

© Copyright 2026, UK Atomic Energy Authority (UKAEA).

Built with Sphinx using a theme provided by Read the Docs.