Internal Documentation

qlbm is made up of 4 main modules. Together, the Base Classes, Amplitude-Based Circuits, and QLGA Circuits module handle the parameterized creation of quantum circuits that compose QBMs. The Lattices and Geometry module parses external information into quantum registers and provides uniform interfaces for underlying algorithms. The Infrastructure module integrates the quantum components with Tket, Qiskit, and Qulacs transpilers and runners. The Other Tools module contains miscellaneous utilities.

• Lattices and Geometry
  • Lattices
    • MSLattice
      • MSLattice.logger
      • MSLattice.num_dims
      • MSLattice.num_gridpoints
      • MSLattice.num_velocities
      • MSLattice.num_total_qubits
      • MSLattice.ancillae_velocity_index()
      • MSLattice.ancillae_obstacle_index()
      • MSLattice.ancillae_comparator_index()
      • MSLattice.grid_index()
      • MSLattice.velocity_index()
      • MSLattice.velocity_dir_index()
      • MSLattice.get_registers()
      • MSLattice.logger_name()
      • MSLattice.has_multiple_geometries()
      • MSLattice.get_encoding()
    • ABLattice
      • ABLattice.num_gridpoints
      • ABLattice.shapes
      • ABLattice.discretization
      • ABLattice.num_base_qubits
      • ABLattice.registers
      • ABLattice.grid_index()
      • ABLattice.velocity_index()
      • ABLattice.ancillae_comparator_index()
      • ABLattice.ancillae_obstacle_index()
      • ABLattice.get_registers()
      • ABLattice.logger_name()
      • ABLattice.has_multiple_geometries()
      • ABLattice.get_encoding()
    • OHLattice
      • OHLattice.num_gridpoints
      • OHLattice.shapes
      • OHLattice.discretization
      • OHLattice.num_base_qubits
      • OHLattice.registers
      • OHLattice.get_registers()
      • OHLattice.logger_name()
      • OHLattice.has_multiple_geometries()
      • OHLattice.get_encoding()
    • SpaceTimeLattice
      • SpaceTimeLattice.grid_index()
      • SpaceTimeLattice.velocity_index()
      • SpaceTimeLattice.ancilla_mass_index()
      • SpaceTimeLattice.ancilla_comparator_index()
      • SpaceTimeLattice.volumetric_ancilla_qubit_combinations()
      • SpaceTimeLattice.get_registers()
      • SpaceTimeLattice.is_inside_an_obstacle()
      • SpaceTimeLattice.logger_name()
      • SpaceTimeLattice.comparator_periodic_volume_bounds()
      • SpaceTimeLattice.has_multiple_geometries()
    • LQLGALattice
      • LQLGALattice.velocity_register
      • LQLGALattice.num_gridpoints
      • LQLGALattice.shapes
      • LQLGALattice.discretization
      • LQLGALattice.num_base_qubits
      • LQLGALattice.num_marker_qubits
      • LQLGALattice.get_registers()
      • LQLGALattice.gridpoint_index_tuple()
      • LQLGALattice.gridpoint_index_flat()
      • LQLGALattice.velocity_index_flat()
      • LQLGALattice.velocity_index_tuple()
      • LQLGALattice.marker_index()
      • LQLGALattice.get_velocity_qubits_of_line()
      • LQLGALattice.logger_name()
      • LQLGALattice.set_geometries()
      • LQLGALattice.has_multiple_geometries()
      • LQLGALattice.has_accumulation_register()
      • LQLGALattice.use_accumulation_register()
      • LQLGALattice.accumulation_index()
  • Geometry
    • Block
      • Block.get_spacetime_reflection_data_d1q2()
      • Block.get_spacetime_reflection_data_d2q4()
      • Block.get_d2q4_volumetric_reflection_data()
      • Block.get_d2q4_surfaces()
      • Block.get_lbm_wall_velocity_indices_to_reflect()
      • Block.get_lbm_near_corner_velocity_indices_to_reflect()
      • Block.get_lbm_outside_corner_indices_to_reflect()
      • Block.get_lqlga_reflection_data_d1q2()
      • Block.get_lqlga_reflection_data_d1q3()
      • Block.contains_gridpoint()
      • Block.stl_mesh()
      • Block.to_json()
      • Block.name()
      • Block.to_dict()
    • Circle
      • Circle.get_circle_perimeter()
      • Circle.stl_mesh()
      • Circle.is_point_on_segment()
      • Circle.is_point_on_any_segment()
      • Circle.split_perimeter_points()
      • Circle.to_json()
      • Circle.name()
      • Circle.to_dict()
      • Circle.contains_gridpoint()
      • Circle.get_spacetime_reflection_data_d1q2()
      • Circle.get_spacetime_reflection_data_d2q4()
      • Circle.get_d2q4_volumetric_reflection_data()
      • Circle.expand_axis_segments()
      • Circle.expand_diagonal_segments()
    • DimensionalReflectionData
    • ReflectionPoint
    • ReflectionWall
    • ReflectionResetEdge
    • SpaceTimePWReflectionData
    • SpaceTimeVolumetricReflectionData
    • SpaceTimeDiagonalReflectionData
• Base Classes
  • Lattice Base
    • Lattice
      • Lattice.num_dims
      • Lattice.num_gridpoints
      • Lattice.num_velocities
      • Lattice.num_grid_qubits
      • Lattice.num_velocity_qubits
      • Lattice.num_ancilla_qubits
      • Lattice.num_total_qubits
      • Lattice.velocity_register
      • Lattice.circuit
      • Lattice.shapes
      • Lattice.register
      • Lattice.discretization
      • Lattice.logger
      • Lattice.parse_input_data()
      • Lattice.parse_geometry_dict()
      • Lattice.to_json()
      • Lattice.get_registers()
      • Lattice.logger_name()
      • Lattice.has_multiple_geometries()
    • AmplitudeLattice
      • AmplitudeLattice.grid_index()
      • AmplitudeLattice.ancillae_comparator_index()
      • AmplitudeLattice.ancillae_obstacle_index()
      • AmplitudeLattice.velocity_index()
      • AmplitudeLattice.get_encoding()
    • Shape
      • Shape.stl_mesh()
      • Shape.to_json()
      • Shape.to_dict()
  • Components Base
    • QuantumComponent
      • QuantumComponent.create_circuit()
      • QuantumComponent.width()
      • QuantumComponent.size()
      • QuantumComponent.dump_qasm3()
      • QuantumComponent.dump_qasm2()
      • QuantumComponent.draw()
    • LBMPrimitive
    • LBMOperator
    • MSOperator
    • SpaceTimeOperator
    • LBMAlgorithm
• Amplitude-Based Circuits
  • End-to-end algorithms
    • CQLBM
    • MSQLBM
    • ABQLBM
  • Initial Conditions
    • MSInitialConditions
    • MSInitialConditions3DSlim
    • ABInitialConditions
  • Streaming
    • MSStreamingOperator
    • StreamingAncillaPreparation
    • ControlledIncrementer
    • SpeedSensitiveAdder
    • SpeedSensitivePhaseShift
    • PhaseShift
    • ABStreamingOperator
  • Reflection
    • BounceBackReflectionOperator
      • BounceBackReflectionOperator.create_circuit()
      • BounceBackReflectionOperator.reflect_wall()
      • BounceBackReflectionOperator.reset_edge_state()
      • BounceBackReflectionOperator.reset_point_state()
      • BounceBackReflectionOperator.flip_and_stream()
    • SpecularReflectionOperator
      • SpecularReflectionOperator.create_circuit()
      • SpecularReflectionOperator.reflect_wall()
      • SpecularReflectionOperator.reset_edge_state()
      • SpecularReflectionOperator.reset_point_state()
      • SpecularReflectionOperator.flip_and_stream()
    • BounceBackWallComparator
    • SpecularWallComparator
    • EdgeComparator
    • Comparator
    • ComparatorMode
    • ABReflectionOperator
  • Measurement
    • GridMeasurement
    • ABGridMeasurement
• QLGA Circuits
  • End-to-end algorithms
    • SpaceTimeQLBM
    • LQLGA
  • Initial Conditions
    • PointWiseSpaceTimeInitialConditions
    • LQGLAInitialConditions
  • Streaming
    • SpaceTimeStreamingOperator
    • LQLGAStreamingOperator
  • Reflection
    • LQLGAReflectionOperator
  • Collision
    • GenericSpaceTimeCollisionOperator
    • SpaceTimeD2Q4CollisionOperator
    • GenericLQLGACollisionOperator
    • EQCPermutation
    • EQCRedistribution
    • EQCCollisionOperator
    • LatticeDiscretization
    • LatticeDiscretizationProperties
    • EquivalenceClass
    • EquivalenceClassGenerator
  • Measurement
    • SpaceTimeGridVelocityMeasurement
    • LQLGAGridVelocityMeasurement
• Infrastructure
  • Runners
    • CircuitRunner
      • CircuitRunner.run()
      • CircuitRunner.new_result()
      • CircuitRunner.new_reinitializer()
      • CircuitRunner.statevector_to_circuit()
    • QiskitRunner
      • QiskitRunner.run()
    • QulacsRunner
      • QulacsRunner.run()
      • QulacsRunner.get_counts()
  • Performance
    • Reinitializer
      • Reinitializer.reinitialize()
      • Reinitializer.requires_statevector()
    • IdentityReinitializer
      • IdentityReinitializer.reinitialize()
      • IdentityReinitializer.requires_statevector()
    • SpaceTimeReinitializer
      • SpaceTimeReinitializer.reinitialize()
      • SpaceTimeReinitializer.counts_to_velocity_pairs()
      • SpaceTimeReinitializer.split_count()
      • SpaceTimeReinitializer.requires_statevector()
  • Compilers
    • CircuitCompiler
      • CircuitCompiler.compile()
  • Results
    • QBMResult
      • QBMResult.visualize_geometry()
      • QBMResult.save_timestep_array()
      • QBMResult.create_visualization()
      • QBMResult.save_timestep_counts()
      • QBMResult.visualize_all_numpy_data()
      • QBMResult.save_statevector()
    • AmplitudeResult
      • AmplitudeResult.num_steps
      • AmplitudeResult.directory
      • AmplitudeResult.output_file_name
      • AmplitudeResult.lattice
      • AmplitudeResult.save_timestep_counts()
      • AmplitudeResult.visualize_all_numpy_data()
    • SpaceTimeResult
      • SpaceTimeResult.num_steps
      • SpaceTimeResult.directory
      • SpaceTimeResult.output_file_name
      • SpaceTimeResult.lattice
      • SpaceTimeResult.save_timestep_counts()
      • SpaceTimeResult.visualize_all_numpy_data()
  • Simulation Config
    • SimulationConfig
      • SimulationConfig.validate()
      • SimulationConfig.prepare_for_simulation()
      • SimulationConfig.get_execution_compiler()
      • SimulationConfig.get_sampling_compiler()
• Other Tools
  • Exceptions
    • LatticeException
    • ResultsException
    • CompilerException
    • CircuitException
    • ExecutionException
  • Utilities
    • create_directory_and_parents()
    • qiskit_circuit_to_qulacs()
    • flatten()
    • bit_value()
    • evaluate_qasm_rotation_string()
    • get_circuit_properties()
    • qiskit_to_qulacs()
    • dimension_letter()
    • is_two_pow()
    • get_time_series()
    • get_qubits_to_invert()