updating docs

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Brian Doolittle <briand4@illinois.edu> and contributors
+Copyright (c) 2020 Brian Doolittle <briand.d.doolittle@gmail.com> and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -6,3 +6,30 @@
 [![Build Status](https://travis-ci.com/ChitambarLab/QBase.jl.svg?branch=master)](https://travis-ci.com/ChitambarLab/QBase.jl)
 [![Coverage](https://codecov.io/gh/ChitambarLab/QBase.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/chitambarlab/QBase.jl)
 [![Coverage Status](https://coveralls.io/repos/github/ChitambarLab/QBase.jl/badge.svg?branch=master)](https://coveralls.io/github/ChitambarLab/QBase.jl?branch=master)
+
+## Features:
+  1. Types and constructors for representing quantum states and operators.
+  2. Methods for evolving quantum systems and performing quantum measurements.
+  3. Methods for computing information-theoretic quantities.
+  4. Mathematics utilities to support quantum calculations.
+
+## Installation
+
+```
+julia> using Pkg; Pkg.add("QBase")
+```
+
+## Citing
+
+Please review [`CITATION.bib`](https://github.com/ChitambarLab/QBase.jl/blob/master/CITATION.bib)
+for citation of this work.
+
+## Licensing
+
+QBase.jl is released under the MIT License.
+
+## Acknowledgements
+
+Development of QBase.jl was made possible by the advisory of Dr. Eric Chitambar
+and general support from the Physics Department at the University of Illinois
+Urbana-Champaign. Funding was provided by NSF Award 1914440.

docs/src/index.md

@@ -15,17 +15,21 @@ CurrentModule = QBase
   3. Methods for computing information-theoretic quantities.
   4. Mathematics utilities to support quantum calculations.
 
+## Citing
+
+Please review [`CITATION.bib`](https://github.com/ChitambarLab/QBase.jl/blob/master/CITATION.bib)
+for citation of this work.
+
+## Licensing
+
+QBase.jl is released under the MIT License.
+
 ## Acknowledgements
 
 Development of QBase.jl was made possible by the advisory of Dr. Eric Chitambar
 and general support from the Physics Department at the University of Illinois
 Urbana-Champaign. Funding was provided by NSF Award 1914440.
 
-## Citing
-
-Please review [`CITATION.bib`](https://github.com/ChitambarLab/QBase.jl/blob/master/CITATION.bib)
-for citation of this work.
-
 ## Contents
 
 ```@contents

docs/src/submodules/States.md

@@ -13,9 +13,9 @@ with vectors (Bra-Ket Representation) or matrices (Density Matrix Representation
 
 ## Bra-Ket Representation
 
-A quantum state may be represented by a vector on a complex-valued Hilbert space.
-In Bra-Ket notation, a quantum state is represented by a ket denoted ``|\psi\rangle``.
-A ket can simply be understood as a column vector. Each ket has an associated dual
+A quantum state is represented by a vector on a complex-valued Hilbert space.
+In Bra-Ket notation, a quantum state denoted  ``|\psi\rangle`` is referred to as
+a ket and is simply understood as a column vector. Each ket has an associated dual
 vector known as a bra. A bra is may be represented by a row vector and can be
 constructed from a ket via Hermitian adjoint, ``\langle\psi| = (|\psi\rangle)^{\dagger}``.
 

docs/src/user_guide.md

@@ -5,5 +5,5 @@
 1. Add the QBase.jl Package:
 
 ```julia
-julia> using Pkg; Pkg.add(PackageSpec(url="https://github.com/ChitambarLab/QBase.jl"))
+julia> using Pkg; Pkg.add("QBase")
 ```

src/Information.jl

@@ -170,7 +170,10 @@ conditional_entropy(
 end
 
 """
-    mutual_information( priors :: QMath.Marginals, conditionals :: QMath.Conditionals ) :: Float64
+    mutual_information(
+        priors :: QMath.Marginals,
+        conditionals :: QMath.Conditionals
+    ) :: Float64
 
 The entropy of the overlap between p(x) and p(y). The information shared from y to x.
 """
@@ -197,7 +200,11 @@ mutual_information(
 end
 
 """
-    success_probability(priors::QMath.Marginals, ρ_states::Vector{<:States.AbstractDensityMatrix}, Π::Observables.AbstractPOVM) :: Float64
+    success_probability(
+        priors::QMath.Marginals,
+        ρ_states::Vector{<:States.AbstractDensityMatrix},
+        Π::Observables.AbstractPOVM
+    ) :: Float64
 
 The probability of correctly distinguishing quantum states with the specifed POVM.
 """
@@ -217,7 +224,11 @@ success_probability(
 end
 
 """
-    error_probability(priors::QMath.Marginals, ρ_states::Vector{<:States.AbstractDensityMatrix}, Π::Observables.AbstractPOVM) :: Float64
+    error_probability(
+        priors::QMath.Marginals,
+        ρ_states::Vector{<:States.AbstractDensityMatrix},
+        Π::Observables.AbstractPOVM
+    ) :: Float64
 
 The probability of incorrectly distinguishing quantum states with the specifed POVM.
 """

src/Observables.jl

@@ -42,7 +42,7 @@ Base.setindex!(P::AbstractPOVM, v, id::Int) = (P.Π[id...] = v)
 Returns `true` if `Π` is a POVM. The following constraints must be satisfied:
 * Each POVM element is hermitian
 * Each POVM element positive semi-definite
-* The POVM is complete: `sum(Π) == identity matrix`
+* The POVM is complete: `sum(Π) == I`
 """
 is_povm(Π::AbstractPOVM) :: Bool = true
 function is_povm(Π::Vector) :: Bool

src/QMath/probability.jl

@@ -53,6 +53,7 @@ p(1|1) & \dots & p(1|M) \\
 \vdots & \ddots & \vdots \\
 p(N|1) & \dots & p(N|M) \\
 \end{bmatrix}
+```
 """
 struct Conditionals <: AbstractMatrix{Float64}
     probabilities :: Matrix{Float64}

src/States.jl

@@ -54,7 +54,7 @@ Base.:*(U::Unitaries.AbstractUnitary, ψ::AbstractKet) :: Ket = Ket(U.U*ψ.ψ)
 Returns `true` if vector `ψ` is a valid ket representation of a quamtum state:
 
 * `ψ` is a real or complex-valued vector.
-* `ψ` is normalized with respect to the bra-ket inner prodcut (`ψ'ψ == 0`).
+* `ψ` is normalized with respect to the bra-ket inner prodcut (`ψ' * ψ == 0`).
 """
 function is_ket(ψ::Vector)::Bool
     norm(ψ) ≈ 1.0
@@ -79,7 +79,7 @@ end
 A ket representation of a 2-dimensional quantum state. When given invalid input,
 the constructor, `QubitKet(ψ)`, throws:
 * `DomainError` - If `ψ` is not normalized.
-* `MethodError` - If `ψ` is not a column vector (`[a,b]` or `[a;b]`).
+* `MethodError` - If `ψ` is not a column vector.
 """
 struct QubitKet <: AbstractKet
     ψ :: Ket
@@ -157,7 +157,7 @@ The method alternatively accepts a `Vector` input.
 
     pure_state( ψ :: Vector ) :: Qubit
 
-A `DomainError` is thrown if `ψ` is not a valid ket.`
+A `DomainError` is thrown if `ψ` is not a valid ket.
 """
 function pure_state(ψ::AbstractKet)::DensityMatrix
     DensityMatrix(ψ*ψ')
@@ -235,7 +235,10 @@ function pure_qubit(ψ::Vector)::Qubit
 end
 
 """
-    mixed_state( priors :: QMath.Marginals, ρ_states :: Vector{<:AbstractDensityMatrix} ) :: DensityMatrix
+    mixed_state(
+        priors :: QMath.Marginals,
+        ρ_states :: Vector{<:AbstractDensityMatrix}
+    ) :: DensityMatrix
 
 Constructs the statistical mixture (weighted average) of quantum states. The
 method accepts states as type `DensityMatrix` or subbtypes `AbstractDensityMatrix`.
@@ -294,15 +297,15 @@ Returns the qubit trine states in density matrix form.
 const trine_qubits = pure_qubit.(trine_qubit_kets)
 
 """
-    mirror_symmetric_qubits(θ) :: Vector{Qubit}
+    mirror_symmetric_qubits( θ ::  Real ) :: Vector{Qubit}
 
 Returns a set of 3 mirror symmetric qubit density matrices. The first
 state is ``|0\\rangle\\langle 0|`` the other two are symmetric about the  ``|0\\rangle`` axis.
 
 Input:
 * `θ ∈ [0,π/2]`: the hilbert space angle between ``|0\\rangle`` and ``|\\psi_{2/3}\\rangle``.
 """
-function mirror_symmetric_qubits(θ)::Vector{Qubit}
+function mirror_symmetric_qubits(θ :: Real)::Vector{Qubit}
     pure_qubit.(mirror_symmetric_qubit_kets(θ))
 end
 

src/Unitaries.jl

@@ -37,7 +37,7 @@ Base.setindex!(unitary::AbstractUnitary, v, id::Int) = (unitary.U[id...] = v)
 
 Returns `true` if matrix `U` is unitary. The hermitian adjoint of a unitary matrix
 is its inverse:
-* `U'U == I` where `I` is the identity matrix.
+* `U' * U == I` where `I` is the identity matrix.
 
 A unitary matrix must be square. A `DomainError` is thrown if input `U` is not square.
 """