wavepacket.builder

Functions to assemble wave functions or density operators.

Functions

`direct_product`(→ wavepacket.grid.State)	Returns the direct product of wave functions as a density operator.
`pure_density`(→ wavepacket.grid.State)	Given an input wave function, create the corresponding pure density operator.
`product_wave_function`(→ wavepacket.grid.State)	Builds a product wave function from a set of one-dimensional wave functions.

Package Contents

wavepacket.builder.direct_product(ket: wavepacket.grid.State, bra: wavepacket.grid.State) → wavepacket.grid.State

Returns the direct product of wave functions as a density operator.

Given two wave functions $\psi, \phi$ , this function returns the density operator as $| \psi \rangle\langle \phi |$ . This operation can be useful to build up a density operator piece by piece.

Parameters:

ketwp.grid.State: The ket state $\psi$
brawp.grid.State: The bra state $\phi$ . Note that the function performs a complex conjugation of this state prior to multiplication.

Returns:

wp.grid.State: The direct product of the two states.

Raises:

wp.BadStateError: If one of the input states is not a valid wave function.
wp.BadGridError: If the input states are defined on different grids.

wavepacket.builder.pure_density(psi: wavepacket.grid.State) → wavepacket.grid.State

Given an input wave function, create the corresponding pure density operator.

This function only performs the direct product, it does not apply further modifications like normalizations.

Parameters:

psiwp.grid.State: The input wave function

Returns:

wp.grid.State: The corresponding density operator.

Raises:

wp.BadStateError: If the input is not a valid wave function.