qflux 0.0.1

qflux is a package for running quantum dynamics calculations on quantum devices.

QFlux - A Quantum Computer Dynamics Package

This repository contains various protocols for performing quantum dynamics simulations with quantum devices. Each submodule contains object implementations for these protocols as demonstrated in a publication, as well as comprehensive tutorial notebooks designed to help users understand, implement and build upon various simulation techniques for studying quantum dynamics using quantum computer frameworks. Each tutorial is provided in Python, using Jupyter Notebooks to offer detailed explanations in both markdown and code comments.

Table of Contents

1. Getting Started
   • Documentation
   • Notebooks For Tutorial Manuscript
   • Additional Repositories
2. Contribution Guidelines
3. Citation
4. License
5. Acknowledgements

Getting Started

Simply select a notebook and execute them locally or in google collab. Necessary dependencies will be installed using pip.

If using uv through the commandline, use the following syntax to create and activate a virtual environment:

uv venv
source .venv/bin/activate

The necessary packages, including development, can be installed as follows:

uv pip install -e ".[dev]"

Documentation

Documentation for QFlux, illustrating its features and representative examples, is available at the following page:

https://qflux.batistalab.com/

Notebooks For Tutorial Manuscript

| Part I - Closed Quantum Dynamics and Simulation Protocols

| Part I - Appendix A: Variational Methods

| Part I - Appendix B: Bosonic Simulation

| Part II - Open Quantum Dynamics

| Part III - Variational Quantum Trajectory Dynamics for FMO

| Part III - Variational Quantum Dynamics for Amplitude Damping

| Part IV - Generalized Quantum Master Equation Dynamics

Contribution Guidelines

To contribute to the repository, clone the qflux repository and create a new branch:

git clone [e-mail]:batistagroup/qflux.git
git pull
git checkout -b part_II_docs_spinchain

For example to contribute to the documentation, written in markdown (.md), edit the markdown in some form and make it complete (vim spin_chain.md for example). Once complete, commit changes to file:

git add spin_chain.md
git commit -m 'DOCS: Added docs on the spin chain example with Lindblad'
git push

Generate a new pull request through github and assign to a tentative reviewer.

Additional Repositories

| Spin Chain Tutorial Repository

| QMultiAdapt Repository

| GQME Tutorial Repository

Citation

Please cite the preprint of our work when using this code until the journal version becomes available.

Licensing

Each notebook or repository might have its own licensing. Please refer to the individual README files and notebooks within each directory for specific licensing information.

Acknowledgement

We acknowledge the financial support of the National Science Foundation under award number 2124511, CCI Phase I: NSF Center for Quantum Dynamics on Modular Quantum Devices (CQD-MQD).