Documentation

Build Status

License

Support

Make simple transformation of complex objects for quantum numerics

PiccoloQuantumObjects

PiccoloQuantumObjects.jl is a Julia package for working with quantum objects. It provides tools for constructing and manipulating quantum states and operators. It is designed to be used with other packages in the Piccolo.jl ecosystem, such as QuantumCollocation.jl and NamedTrajectories.jl.

Installation

This package is registered! To install, enter the Julia REPL, type ] to enter pkg mode, and then run:

pkg> add PiccoloQuantumObjects

Usage

The following example demonstrates how to create a quantum state, create a quantum operator, and apply the operator to the state:

using PiccoloQuantumObjects

# Create a quantum state
state = ket_from_string("g", [2])

# Create a quantum operator
operator = PAULIS.X

# Apply the operator to the state
new_state = operator * state

# Transform the state to its real representation
new_iso_state = ket_to_iso(new_state)

# Transform back
iso_to_ket(new_iso_state)

Building Documentation

This package uses a Documenter config that is shared with many of our other repositories. To build the docs, you will need to run the docs setup script to clone and pull down the utility.

# first time only
./docs/get_docs_utils.sh   # or ./get_docs_utils.sh if cwd is in ./docs/

To build the docs pages:

julia --project=docs docs/make.jl

or editing the docs live:

julia --project=docs
> using LiveServer, PiccoloQuantumObjects, Revise
> servedocs(literate_dir="docs/literate", skip_dirs=["docs/src/generated", "docs/src/assets/"], skip_files=["docs/src/index.md"])

Note: servedocs needs to watch a subset of the files in the docs/ folder. If it watches files that are generated on a docs build/re-build, servedocs will continuously try to re-serve the pages.

To prevent this, ensure all generated files are included in the skip dirs or skip files args for servedocs.

For example, if we forget index.md like so:

julia --project=docs
> using LiveServer, PiccoloQuantumObjects, Revise
> servedocs(literate_dir="docs/literate", skip_dirs=["docs/src/generated", "docs/src/assets/"])

it will not build and serve.

---

"It seems that perfection is attained not when there is nothing more to add, but when there is nothing more to take away." - Antoine de Saint-Exupéry