Tangelo is an open-source Python package maintained by Good Chemistry Company, focusing on the development of quantum chemistry simulation workflows on quantum computers. It was developed as an engine to accelerate research, and takes advantage of other popular frameworks to harness the innovation in our field.

Tutorials · Features · Docs · Blog

This package provides a growing collection of algorithms and toolboxes to support quantum algorithms R&D and the design of successful experiments on quantum devices. Tangelo is backend-agnostic, which means users can write quantum algortihms once and run their calculations on current and future platforms with minimal changes. Tangelo is capable to perform quantum experiments that led to publications in scientific journals, co-authored by professionals from the chemical industry and quantum hardware manufacturers.

We hope to grow a healthy community around Tangelo, collaborate, and together leverage the best of what the field has to offer. What will you do with Tangelo ?

Install

1. Using pip

The easiest way to install Tangelo in your local environment.

python -m pip install --upgrade pip.
pip install tangelo-gc

If you'd like to install via pip the code in a specific branch of this Github repository (let's say develop, which is usually the most advanced):

pip install git+https://github.com/goodchemistryco/Tangelo.git@develop

2. From source, using setuptools

After downloading the contents of this repo, you can install Tangelo using the following command, which uses setup.py:

python -m pip install .

Optional dependencies: Quantum Simulators and Classical Quantum Chemistry

Tangelo enables users to target various backends. In particular, it integrates quantum circuit simulators such as qulacs, qiskit, cirq, among others. We leave it to you to install the packages of your choice, and refer to their own documentation. Most packages can be installed through pip or conda easily. Tangelo can be used without having a classical quantum chemistry package installed but many chemistry algorithms need one. The two quantum chemistry packages that are natively supported are PySCF and Psi4, which can be installed through pip or conda. It is possible to plug in your own pre-computed integrals and other chemistry calculations done with the tools of your choice, or your own compute backend for executing quantum algorithms.

Optional: environment variables

The bash file env_var.sh shows a number of environment variables used in Tangelo, for purposes such as computational performance or credentials for quantum experiments. You can either source this file in your terminal, or set these variables inside your python script / notebooks using the os package.

Tutorials and examples

We have a dedicated repository for examples and tutorials ! You can get started with just a few clicks. Tutorials are organized following a colorful tag system to help people find what is relevant to them. They contain insightful information and advice about chemistry simulations, quantum computing experiments and using Tangelo. Tangelo users can also contribute to this repository and showcase their own work.

Check out our tutorials file for more details.

Tests

Unit tests can be found in the tests folders, located in the various toolboxes they are related to. To automatically find and run all tests (some tests will fail or be skipped if a dependency is not installed):

python -m unittest

Contributions

Thank you very much for considering contributing to this project; we'd love to have you on board ! You do not need to be a seasoned software developer or expert in your field to make contributions to this project: it will take various kinds of people and backgrounds to tackle the challenges that await us.

You can use the Issue tab to open a bug report or feature request. Starting a discussion in the Discussion tab is also a good start: we'll figure it out from there.

The contribution process is detailed in the contributions file. Don't feel intimidated: we work at the intersection of many difficult fields and we're here to help. By joining the Tangelo community and sharing your ideas and developments, you are creating an opportunity for us to grow together, and take ideas to the finish line and beyond.

Citations

If you use Tangelo in your research, please cite the Tangelo release paper and consider mentioning Tangelo in your talks.

@article{tangelo,
   author = {Valentin Senicourt and James Brown and Alexandre Fleury and Ryan Day and Erika Lloyd and Marc P. Coons and Krzysztof Bieniasz and Lee Huntington and Alejandro J. Garza and Shunji Matsuura and Rudi Plesch and Takeshi Yamazaki and Arman Zaribafiyan},
   title = {Tangelo: An Open-source Python Package for End-to-end Chemistry Workflows on Quantum Computers},
   year = {2022},
   url= {https://arxiv.org/abs/2206.12424},
   number = {arXiv:2206.12424},
   eprint = {arXiv:2206.12424},
   publisher = {{arXiv}},
   doi = {10.48550/arXiv.2206.12424}
}

nguyenducnhaty / Tangelo