neutronbraggedge

Contents

  • Installation
    • Requirements
    • Install from PyPI
    • Install from Source
    • Using Pixi (Recommended for Development)
    • Verify Installation
  • How to use This library
    • Metadata of Elements
    • Lambda Calculation
    • Distance source-Detector Calculation
    • Detector Offset Calculation
    • Lattice Calculator
  • The API Reference
    • NewMaterialDict
      • NewMaterialDict.name
      • NewMaterialDict.lattice
      • NewMaterialDict.crystal_structure
      • NewMaterialDict.name
      • NewMaterialDict.lattice
      • NewMaterialDict.crystal_structure
    • BraggEdge
      • BraggEdge.material
      • BraggEdge.hkl
      • BraggEdge.bragg_edges
      • BraggEdge.d_spacing
      • BraggEdge.metadata
      • BraggEdge.hkl
      • BraggEdge.metadata
      • BraggEdge.bragg_edges
      • BraggEdge.d_spacing
      • BraggEdge.lattice
      • BraggEdge.crystal_structure
      • BraggEdge.__init__()
      • BraggEdge.material
      • BraggEdge.number_of_bragg_edges
      • BraggEdge.use_local_metadata_table
      • BraggEdge.to_result()
      • BraggEdge.get_experimental_lattice_parameter()
      • BraggEdge.export()

API Reference

  • The Material Handler Reference
    • RetrieveMaterialMetadata
      • RetrieveMaterialMetadata.table
      • RetrieveMaterialMetadata.__init__()
      • RetrieveMaterialMetadata.use_local_table
      • RetrieveMaterialMetadata.lattice
      • RetrieveMaterialMetadata.crystal_structure
      • RetrieveMaterialMetadata.full_list_material()
    • RetrieveMetadataTable
      • RetrieveMetadataTable.url
      • RetrieveMetadataTable.table
      • RetrieveMetadataTable.raw_table
      • RetrieveMetadataTable.__init__()
      • RetrieveMetadataTable.use_local_table
      • RetrieveMetadataTable.retrieve_table()
      • RetrieveMetadataTable.retrieve_table_local()
      • RetrieveMetadataTable.retrieve_table_from_url()
      • RetrieveMetadataTable.format_table_from_url()
      • RetrieveMetadataTable.get_table()
  • The BraggEdges Handler Reference
    • BraggEdgeCalculator
      • BraggEdgeCalculator.hkl
      • BraggEdgeCalculator.bragg_edges
      • BraggEdgeCalculator.d_spacing
      • BraggEdgeCalculator.__init__()
      • BraggEdgeCalculator.lattice
      • BraggEdgeCalculator.structure
      • BraggEdgeCalculator.calculate_hkl()
      • BraggEdgeCalculator.calculate_bragg_edges()
    • BCCHandler
      • BCCHandler.__init__()
      • BCCHandler.hkl
      • BCCHandler.number_of_set
      • BCCHandler.calculate_hkl()
    • FCCHandler
      • FCCHandler.__init__()
      • FCCHandler.hkl
      • FCCHandler.number_of_set
      • FCCHandler.calculate_hkl()
    • StructureHandler
      • StructureHandler.__init__()
      • StructureHandler.structure
      • StructureHandler.number_of_set
      • StructureHandler.hkl
  • The Experiment Handler Reference
    • Experiment
      • Experiment.__init__()
      • Experiment.tof_array
      • Experiment.distance_source_detector
      • Experiment.detector_offset_micros
      • Experiment.lambda_array
      • Experiment.calculate_tof_with_detector_offset()
      • Experiment.calculate_distance_source_detector()
      • Experiment.calculate_detector_offset()
      • Experiment.calculate_lambda()
      • Experiment.export_lambda()
    • TOF
      • TOF.counts_array
      • TOF.__init__()
      • TOF.filename
      • TOF.tof_array
      • TOF.load_data()
    • LambdaWavelength
      • LambdaWavelength.__init__()
      • LambdaWavelength.filename
      • LambdaWavelength.lambda_array
      • LambdaWavelength.load_data()
  • The Lattice Handler Reference
    • Lattice
      • Lattice.material
      • Lattice.crystal_structure
      • Lattice.bragg_edge_array
      • Lattice.bragg_edge_error_array
      • Lattice.hkl
      • Lattice.lattice_array
      • Lattice.lattice_error
      • Lattice.lattice_statistics
      • Lattice.space
      • Lattice.hkl_bragg_edge
      • Lattice.lattice_array
      • Lattice.lattice_error
      • Lattice.lattice_statistics
      • Lattice.__init__()
      • Lattice.material
      • Lattice.use_local_metadata
      • Lattice.bragg_edge_array
      • Lattice.bragg_edge_error_array
      • Lattice.hkl
      • Lattice.crystal_structure
      • Lattice.get_statistics()
      • Lattice.display_hkl_bragg_edge()
      • Lattice.display_lattice_statistics()
      • Lattice.display_recap()
  • The Utilities Reference
    • Utilities
      • Utilities.list_of_time_units
      • Utilities.convert_time_units()
      • Utilities.get_time_conversion_coeff()
      • Utilities.array_multiply_coeff()
      • Utilities.array_add_coeff()
      • Utilities.array_divide_array()
      • Utilities.array_minus_array()
      • Utilities.load_csv()
      • Utilities.load_ascii()
      • Utilities.save_csv()
neutronbraggedge
  • Overview: module code

All modules for which code is available

  • neutronbraggedge.braggedge
  • neutronbraggedge.braggedges_handler.braggedge_calculator
  • neutronbraggedge.braggedges_handler.structure_handler
  • neutronbraggedge.experiment_handler.experiment
  • neutronbraggedge.experiment_handler.lambda_wavelength
  • neutronbraggedge.experiment_handler.tof
  • neutronbraggedge.lattice_handler.lattice
  • neutronbraggedge.material_handler.retrieve_material_metadata
  • neutronbraggedge.material_handler.retrieve_metadata_table
  • neutronbraggedge.utilities

© Copyright 2016-2026, UT-Battelle, LLC.

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