xrdt
0.0.1

xrdt Documentation

  • Installation
  • Configuration
    • Environment variables
    • Definition of environment variables
      • Example: Setting the XRD Measurement Data Directory
  • Command line interface
    • Commands
      • xrdt
        • database
        • device
        • measurement
        • preset
        • template
  • Python API
    • xrd_tools package
      • Subpackages
        • xrd_tools.plugins package
      • Submodules
      • xrd_tools.analyse_measurements module
        • AnalyseMeasurements
      • xrd_tools.config module
      • xrd_tools.database module
        • DBentry
        • MeasurementDatabase
      • xrd_tools.device module
        • BaseDevice
        • HTChamber
        • LabDiffractometer
      • xrd_tools.device_factory module
        • Device
        • create()
        • register()
        • unregister()
      • xrd_tools.device_manager module
        • DeviceManager
      • xrd_tools.measurement module
        • Measurement
        • NoRefinerSetError
        • get_data()
      • xrd_tools.measurement_manager module
        • MeasurementManager
        • create_zip_archive()
        • read_from_ascii()
      • xrd_tools.meta module
        • Meta
      • xrd_tools.paths module
        • MeasurementPaths
      • xrd_tools.plugin_loader module
        • ModuleInterface
        • get_plugins()
        • import_module()
        • load_plugins()
      • xrd_tools.preset_manager module
        • PresetManager
      • xrd_tools.refinement module
        • RefinedPhase
        • RefinementResult
      • xrd_tools.refinement_interface module
        • AppNotInstalledError
        • RefinementInterface
      • xrd_tools.refinement_interface_factory module
        • create()
        • register()
        • unregister()
      • xrd_tools.templates module
        • TemplateManager
        • get_template_cli()
      • xrd_tools.utils module
        • ensure_file_exists()
        • make_dirs()
        • raise_file_exists()
        • write_to_json()
      • Module contents
  • Plugins
    • Refinement interfaces
      • xrd_tools.plugins.refinement_profex
        • ProfexInterface
        • register()
  • Changelog

User Guide

  • 1. Structure of the measurements directory
    • 1.1. Measurement protocol
    • 1.2. Refined data
  • 2. Handling of devices
    • 2.1. Add a new device
    • 2.2. List registered devices
    • 2.3. Remove a registered device
  • 3. Handling of presets
  • 4. Handling of templates
  • 5. Handling of measurements
  • 6. Measurement database
xrdt
  • Overview: module code

All modules for which code is available

  • xrd_tools.analyse_measurements
  • xrd_tools.database
  • xrd_tools.device
  • xrd_tools.device_factory
  • xrd_tools.device_manager
  • xrd_tools.measurement
  • xrd_tools.measurement_manager
  • xrd_tools.meta
  • xrd_tools.paths
  • xrd_tools.plugin_loader
  • xrd_tools.plugins.refinement_profex
  • xrd_tools.preset_manager
  • xrd_tools.refinement
  • xrd_tools.refinement_interface
  • xrd_tools.refinement_interface_factory
  • xrd_tools.templates
  • xrd_tools.utils

© Copyright 2023, Christian Schreinemachers (Cs137).

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