#!/usr/bin/env python
# coding: utf-8

# # Lecture 0 - Introduction to QuTiP
# 
# Author: J. R. Johansson (robert@riken.jp), https://jrjohansson.github.io/
# 
# This lecture series was developed by J.R. Johannson. The original lecture notebooks are available [here](https://github.com/jrjohansson/qutip-lectures).
# 
# This is a slightly modified version of the lectures, to work with the current release of QuTiP. You can find these lectures as a part of the [qutip-tutorials repository](https://github.com/qutip/qutip-tutorials). This lecture and other tutorial notebooks are indexed at the [QuTiP Tutorial webpage](https://qutip.org/tutorials.html).

# In[1]:


import matplotlib.pyplot as plt
import numpy as np
from IPython.display import Image
from qutip import (Qobj, about, basis, coherent, coherent_dm, create, destroy,
                   expect, fock, fock_dm, mesolve, qeye, sigmax, sigmay,
                   sigmaz, tensor, thermal_dm)

get_ipython().run_line_magic('matplotlib', 'inline')


# ## Introduction
# 
# QuTiP is a python package for calculations and numerical simulations of quantum systems. 
# 
# It includes facilities for representing and doing calculations with quantum objects such state vectors (wavefunctions), as bras/kets/density matrices, quantum operators of single and composite systems, and superoperators (useful for defining master equations).
# 
# It also includes solvers for a time-evolution of quantum systems, according to: Schrodinger equation, von Neuman equation, master equations, Floquet formalism, Monte-Carlo quantum trajectors, experimental implementations of the stochastic Schrodinger/master equations.
# 
# For more information see the project web site at [qutip.org](https://qutip.org), and the 
# [QuTiP documentation](https://qutip.readthedocs.io/en/latest/index.html).
# 
# ### Installation
# 
# You can install QuTiP directly from `pip` by running:
# 
# `pip install qutip`
# 
# For further installation details, refer to the [GitHub repository](https://github.com/qutip/qutip).

# To use QuTiP in a Python program, first include the relevant functionality from the `qutip` module as shown above.
# 
# This will make the functions and classes in QuTiP available in the rest of the program.

# ## Quantum object class: `qobj`
# 
# At the heart of the QuTiP package is the `Qobj` class, which is used for representing quantum object such as states and operator. 
# 
# The `Qobj` class contains all the information required to describe a quantum system, such as its matrix representation, composite structure and dimensionality.

# In[2]:


Image(filename="images/qobj.png")


# ### Creating and inspecting quantum objects

# We can create a new quantum object using the `Qobj` class constructor, like this:

# In[3]:


q = Qobj([[1], [0]])

q


# Here we passed python list as an argument to the class constructor. The data in this list is used to construct the matrix representation of the quantum objects, and the other properties of the quantum object is by default computed from the same data.
# 
# We can inspect the properties of a `Qobj` instance using the following class method:

# In[4]:


# the dimension, or composite Hilbert state space structure
q.dims


# In[5]:


# the shape of the matrix data representation
q.shape


# In[6]:


# the matrix data itself. in sparse matrix format.
q.data


# In[7]:


# get the dense matrix representation
q.full()


# In[8]:


# some additional properties
q.isherm, q.type


# ### Using `Qobj` instances for calculations
# 
# With `Qobj` instances we can do arithmetic and apply a number of different operations using class methods:

# In[9]:


sy = Qobj([[0, -1j], [1j, 0]])  # the sigma-y Pauli operator

sy


# In[10]:


sz = Qobj([[1, 0], [0, -1]])  # the sigma-z Pauli operator

sz


# In[11]:


# some arithmetic with quantum objects

H = 1.0 * sz + 0.1 * sy

print("Qubit Hamiltonian = \n")
H


# Example of modifying quantum objects using the `Qobj` methods:

# In[12]:


# The hermitian conjugate
sy.dag()


# In[13]:


# The trace
H.tr()


# In[14]:


# Eigen energies
H.eigenenergies()


# For a complete list of methods and properties of the `Qobj` class, see the [QuTiP documentation](https://qutip.readthedocs.io/en/latest/index.html) or try `help(Qobj)` or `dir(Qobj)`.

# ## States and operators
# 
# Normally we do not need to create `Qobj` instances from stratch, using its constructor and passing its matrix represantation as argument. Instead we can use functions in QuTiP that generates common states and operators for us. Here are some examples of built-in state functions:
# 
# ### State vectors

# In[15]:


# Fundamental basis states (Fock states of oscillator modes)

N = 2  # number of states in the Hilbert space
n = 1  # the state that will be occupied

basis(N, n)  # equivalent to fock(N, n)


# In[16]:


fock(4, 2)  # another example


# In[17]:


# a coherent state
coherent(N=10, alpha=1.0)


# ### Density matrices

# In[18]:


# a fock state as density matrix
fock_dm(5, 2)  # 5 = hilbert space size, 2 = state that is occupied


# In[19]:


# coherent state as density matrix
coherent_dm(N=8, alpha=1.0)


# In[20]:


# thermal state
n = 1  # average number of thermal photons
thermal_dm(8, n)


# ### Operators

# #### Qubit (two-level system) operators

# In[21]:


# Pauli sigma x
sigmax()


# In[22]:


# Pauli sigma y
sigmay()


# In[23]:


# Pauli sigma z
sigmaz()


# #### Harmonic oscillator operators

# In[24]:


#  annihilation operator

destroy(N=8)  # N = number of fock states included in the Hilbert space


# In[25]:


# creation operator

create(N=8)  # equivalent to destroy(5).dag()


# In[26]:


# the position operator is easily constructed from the annihilation operator
a = destroy(8)

x = a + a.dag()

x


# #### Using `Qobj` instances we can check some well known commutation relations:

# In[27]:


def commutator(op1, op2):
    return op1 * op2 - op2 * op1


# $[a, a^1] = 1$

# In[28]:


a = destroy(5)

commutator(a, a.dag())


# **Ops...** The result is not identity! Why? Because we have truncated the Hilbert space. But that's OK as long as the highest Fock state isn't involved in the dynamics in our truncated Hilbert space. If it is, the approximation that the truncation introduces might be a problem.

# $[x,p] = i$

# In[29]:


x = (a + a.dag()) / np.sqrt(2)
p = -1j * (a - a.dag()) / np.sqrt(2)


# In[30]:


commutator(x, p)


# Same issue with the truncated Hilbert space, but otherwise OK.

# Let's try some Pauli spin inequalities
# 
# $[\sigma_x, \sigma_y] = 2i \sigma_z$

# In[31]:


commutator(sigmax(), sigmay()) - 2j * sigmaz()


# $-i \sigma_x \sigma_y \sigma_z = \mathbf{1}$

# In[32]:


-1j * sigmax() * sigmay() * sigmaz()


# $\sigma_x^2 = \sigma_y^2 = \sigma_z^2 = \mathbf{1}$

# In[33]:


sigmax() ** 2 == sigmay() ** 2 == sigmaz() ** 2 == qeye(2)


# ## Composite systems
# 
# In most cases we are interested in coupled quantum systems, for example coupled qubits, a qubit coupled to a cavity (oscillator mode), etc.
# 
# To define states and operators for such systems in QuTiP, we use the `tensor` function to create `Qobj` instances for the composite system.
# 
# For example, consider a system composed of two qubits. If we want to create a Pauli $\sigma_z$ operator that acts on the first qubit and leaves the second qubit unaffected (i.e., the operator $\sigma_z \otimes \mathbf{1}$), we would do:

# In[34]:


sz1 = tensor(sigmaz(), qeye(2))

sz1


# We can easily verify that this two-qubit operator does indeed have the desired properties:

# In[35]:


psi1 = tensor(basis(N, 1), basis(N, 0))  # excited first qubit
psi2 = tensor(basis(N, 0), basis(N, 1))  # excited second qubit


# In[36]:


# this should not be true,
# because sz1 should flip the sign of the excited state of psi1
sz1 * psi1 == psi1


# In[37]:


# this should be true, because sz1 should leave psi2 unaffected
sz1 * psi2 == psi2


# Above we used the `qeye(N)` function, which generates the identity operator with `N` quantum states. If we want to do the same thing for the second qubit we can do:

# In[38]:


sz2 = tensor(qeye(2), sigmaz())

sz2


# Note the order of the argument to the `tensor` function, and the correspondingly different matrix representation of the two operators `sz1` and `sz2`.
# 
# Using the same method we can create coupling terms of the form $\sigma_x \otimes \sigma_x$:

# In[39]:


tensor(sigmax(), sigmax())


# Now we are ready to create a `Qobj` representation of a coupled two-qubit Hamiltonian: $H = \epsilon_1 \sigma_z^{(1)} + \epsilon_2 \sigma_z^{(2)} + g \sigma_x^{(1)}\sigma_x^{(2)}$

# In[40]:


epsilon = [1.0, 1.0]
g = 0.1

sz1 = tensor(sigmaz(), qeye(2))
sz2 = tensor(qeye(2), sigmaz())

H = epsilon[0] * sz1 + epsilon[1] * sz2 + g * tensor(sigmax(), sigmax())

H


# To create composite systems of different types, all we need to do is to change the operators that we pass to the `tensor` function (which can take an arbitrary number of operator for composite systems with many components).
# 
# For example, the Jaynes-Cumming Hamiltonian for a qubit-cavity system:
# 
# $H = \omega_c a^\dagger a - \frac{1}{2}\omega_a \sigma_z + g (a \sigma_+ + a^\dagger \sigma_-)$

# In[41]:


wc = 1.0  # cavity frequency
wa = 1.0  # qubit/atom frenqency
g = 0.1  # coupling strength

# cavity mode operator
a = tensor(destroy(5), qeye(2))

# qubit/atom operators
sz = tensor(qeye(5), sigmaz())  # sigma-z operator
sm = tensor(qeye(5), destroy(2))  # sigma-minus operator

# the Jaynes-Cumming Hamiltonian
H = wc * a.dag() * a - 0.5 * wa * sz + g * (a * sm.dag() + a.dag() * sm)

H


# Note that 
# 
# $a \sigma_+ = (a \otimes \mathbf{1}) (\mathbf{1} \otimes \sigma_+)$
# 
# so the following two are identical:

# In[42]:


a = tensor(destroy(3), qeye(2))
sp = tensor(qeye(3), create(2))

a * sp


# In[43]:


tensor(destroy(3), create(2))


# ## Unitary dynamics
# 
# Unitary evolution of a quantum system in QuTiP can be calculated with the `mesolve` function. 
# 
# `mesolve` is short for Master-eqaution solve (for dissipative dynamics), but if no collapse operators (which describe the dissipation) are given to the solve it falls back on the unitary evolution of the Schrodinger (for initial states in state vector for) or the von Neuman equation (for initial states in density matrix form).
# 
# The evolution solvers in QuTiP returns a class of type `Odedata`, which contains the solution to the problem posed to the evolution solver. 
# 
# For example, considor a qubit with Hamiltonian $H = \sigma_x$ and initial state $\left|1\right>$ (in the sigma-z basis): Its evolution can be calculated as follows:

# In[44]:


# Hamiltonian
H = sigmax()

# initial state
psi0 = basis(2, 0)

# list of times for which the solver should store the state vector
tlist = np.linspace(0, 10, 100)

result = mesolve(H, psi0, tlist, [], [])


# In[45]:


result


# The `result` object contains a list of the wavefunctions at the times requested with the `tlist` array. 

# In[46]:


len(result.states)


# In[47]:


result.states[-1]  # the finial state


# ### Expectation values
# 
# The expectation values of an operator given a state vector or density matrix (or list thereof) can be calculated using the `expect` function. 

# In[48]:


expect(sigmaz(), result.states[-1])


# In[49]:


expect(sigmaz(), result.states)


# In[50]:


fig, axes = plt.subplots(1, 1)

axes.plot(tlist, expect(sigmaz(), result.states))

axes.set_xlabel(r"$t$", fontsize=20)
axes.set_ylabel(r"$\left<\sigma_z\right>$", fontsize=20);


# If we are only interested in expectation values, we could pass a list of operators to the `mesolve` function that we want expectation values for, and have the solver compute then and store the results in the `Odedata` class instance that it returns.
# 
# For example, to request that the solver calculates the expectation values for the operators $\sigma_x, \sigma_y, \sigma_z$:

# In[51]:


result = mesolve(H, psi0, tlist, [], [sigmax(), sigmay(), sigmaz()])


# Now the expectation values are available in `result.expect[0]`, `result.expect[1]`, and `result.expect[2]`:

# In[52]:


fig, axes = plt.subplots(1, 1)

axes.plot(tlist, result.expect[2], label=r"$\left<\sigma_z\right>$")
axes.plot(tlist, result.expect[1], label=r"$\left<\sigma_y\right>$")
axes.plot(tlist, result.expect[0], label=r"$\left<\sigma_x\right>$")

axes.set_xlabel(r"$t$", fontsize=20)
axes.legend(loc=2);


# ## Dissipative dynamics
# 
# To add dissipation to a problem, all we need to do is to define a list of collapse operators to the call to the `mesolve` solver.
# 
# A collapse operator is an operator that describes how the system is interacting with its environment. 
# 
# For example, consider a quantum harmonic oscillator with Hamiltonian 
# 
# $H = \hbar\omega a^\dagger a$
# 
# and which loses photons to its environment with a relaxation rate $\kappa$. The collapse operator that describes this process is 
# 
# $\sqrt{\kappa} a$
# 
# since $a$ is the photon annihilation operator of the oscillator. 
# 
# To program this problem in QuTiP:

# In[53]:


w = 1.0  # oscillator frequency
kappa = 0.1  # relaxation rate
a = destroy(10)  # oscillator annihilation operator
rho0 = fock_dm(10, 5)  # initial state, fock state with 5 photons
H = w * a.dag() * a  # Hamiltonian

# A list of collapse operators
c_ops = [np.sqrt(kappa) * a]


# In[54]:


tlist = np.linspace(0, 50, 100)

# request that the solver return the expectation value
# of the photon number state operator a.dag() * a
result = mesolve(H, rho0, tlist, c_ops, [a.dag() * a])


# In[55]:


fig, axes = plt.subplots(1, 1)
axes.plot(tlist, result.expect[0])
axes.set_xlabel(r"$t$", fontsize=20)
axes.set_ylabel(r"Photon number", fontsize=16);


# ### Installation information

# In[56]:


about()