Skip to content

ClarkResearchGroup/qosy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QOSY: Quantum Operators from SYmmetries

Qosy is a python package for constructing quantum operators with desired symmetry properties, which can include continuous or discrete symmetries.

Features

Qosy provides a simple set of tools to

  • specify a basis of Hermitian operators
  • specify desired continuous symmetries represented by integrals of motion
  • specify desired discrete symmetries represented by transformation rules
  • generate all the Hermitian operators in the basis of operators with these symmetries

The tools can be used as either (1) a "forward method" to automatically generate the symmetries of a Hamiltonian or as (2) an "inverse method" to automatically construct Hamiltonians with desired symmetries.

Getting Started

Prerequisites

Qosy requires the following software installed on your platform:

Installing

To copy the development version of the code to your machine, type

git clone https://github.com/ClarkResearchGroup/qosy.git

To install, type

cd qosy
python setup.py install --user

or add the qosy folder to your PYTHONPATH environment variable.

Documentation

To generate the documentation on your machine, type

cd qosy/docs
make html

To view it, type

firefox _build/html/index.html

Testing

To test Qosy after installation (recommended), type

cd qosy/tests
pytest

Tutorials

Some introductory ipython notebooks and scripts for generating results shown in [1] are available in the tutorials folder.

Authors

  • Eli Chertkov

License

This project is licensed under the MIT License - see the LICENSE for details.

References

Based on work presented in

[1] E. Chertkov, B. Villalonga, and B. K. Clark, “Engineering Topological Models with a General-Purpose Symmetry-to-Hamiltonian Approach,” Phys. Rev. Research 2, 023348 (2020).

About

Quantum Operators from SYmmetry

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published