Software Reference

• CyRSoXS Simulation Components
  • Morphology File Structure
    • Vector Morphology HDF5 Structure
    • Euler Morphology HDF5 Structure
  • Material Optical Constant File Structure
  • Configuration File Structure
    • Table of Configuration File Options
    • Configuration File Option Descriptions
• NRSS.writer
  • dump_data()
  • dump_dataVacuum()
  • find_nearest()
  • get_interpolated_value()
  • removeDuplicates()
  • writeList()
  • write_config()
  • write_hdf5()
  • write_materials()
  • write_opts()
  • write_slurm()
• NRSS.checkH5
  • checkH5()
  • check_NumMat()
  • inset_axes()
  • rc()
  • readH5_euler()
  • readH5_vector()
• NRSS.morphology
  • BackendUnavailableError
  • Material
    • Material.materialID
    • Material.Vfrac
    • Material.S
    • Material.theta
    • Material.psi
    • Material.NumZYX
    • Material.name
    • Material.copy()
  • Morphology
    • Morphology.input_mapping
    • Morphology.numMaterial
    • Morphology.materials
    • Morphology.PhysSize
    • Morphology.NumZYX
    • Morphology.config
    • Morphology.create_cy_object
    • Morphology.simulated
    • Morphology.load_morph_hdf5()
    • Morphology.create_inputData()
    • Morphology.create_optical_constants()
    • Morphology.create_voxel_data()
    • Morphology.run()
    • Morphology.scattering_to_xarray()
    • Morphology.AlgorithmType
    • Morphology.CaseType
    • Morphology.EAngleRotation
    • Morphology.Energies
    • Morphology.EwaldsInterpolation
    • Morphology.MorphologyType
    • Morphology.PhysSize
    • Morphology.ReferenceFrame
    • Morphology.RotMask
    • Morphology.WindowingType
    • Morphology.authoritative_array_contract
    • Morphology.backend
    • Morphology.backend_array_contract
    • Morphology.backend_dtype
    • Morphology.backend_info
    • Morphology.backend_options
    • Morphology.backend_timings
    • Morphology.check_materials()
    • Morphology.config
    • Morphology.config_default
    • Morphology.config_to_inputData()
    • Morphology.create_inputData()
    • Morphology.create_optical_constants()
    • Morphology.create_update_cy()
    • Morphology.create_voxel_data()
    • Morphology.input_policy
    • Morphology.load_config()
    • Morphology.load_matfile()
    • Morphology.load_morph_hdf5()
    • Morphology.mixed_precision_mode
    • Morphology.normalize_materials_for_backend()
    • Morphology.numMaterial
    • Morphology.output_policy
    • Morphology.ownership_policy
    • Morphology.prepare()
    • Morphology.refresh_backend_assessment()
    • Morphology.release_runtime()
    • Morphology.resident_mode
    • Morphology.run()
    • Morphology.runtime_compute_contract
    • Morphology.runtime_compute_dtype
    • Morphology.runtime_dtype
    • Morphology.scattering_to_xarray()
    • Morphology.simulated
    • Morphology.update_optical_constants()
    • Morphology.update_voxel_data()
    • Morphology.validate_all()
    • Morphology.visualize_materials()
    • Morphology.write_config()
    • Morphology.write_constants()
    • Morphology.write_to_file()
    • Morphology.z_collapse_mode
  • OpticalConstants
    • OpticalConstants.energies
    • OpticalConstants.opt_constants
    • OpticalConstants.name
    • OpticalConstants.calc_constants()
    • OpticalConstants.load_matfile()
    • OpticalConstants.create_vacuum()
    • OpticalConstants.calc_constants()
    • OpticalConstants.create_vacuum()
    • OpticalConstants.load_matfile()
  • ParamSpec
    • ParamSpec.args
    • ParamSpec.kwargs
  • SFieldMode
    • SFieldMode.ISOTROPIC
  • TypeVar
  • assess_array_for_backend()
  • check_NumMat()
  • coerce_array_for_backend()
  • get_backend_info()
  • get_backend_runtime()
  • get_namespace_module()
  • inspect_array()
  • is_isotropic_s_field_mode()
  • morphology_visualizer()
  • normalize_backend_options()
  • normalize_resident_mode()
  • read_config()
  • read_material()
  • resolve_backend_array_contract()
  • resolve_backend_name()
  • resolve_backend_runtime_contract()
  • to_python_bool()
  • wraps()
  • write_hdf5()
  • write_opts()
• NRSS.reader
  • read_config()
  • read_material()