Metadata-Version: 2.4
Name: qcheff
Version: 0.2.1
Summary: Effective Hamiltonian calculator for quantum systems.
Keywords: 
Author: abhishekchak52, taylorpatti
Author-email: abhishekchak52 <abhishekchak52@gmail.com>, taylorpatti <tpatti@nvidia.com>
License-Expression: MIT
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: more-itertools>=10.4.0
Requires-Dist: numpy>=2.0.0
Requires-Dist: scipy>=1.13
Requires-Dist: cupy-cuda11x>=13.3.0 ; extra == 'cupy-cuda11x'
Requires-Dist: cupy-cuda12x>=13.3.0 ; extra == 'cupy-cuda12x'
Requires-Dist: cupy-cuda13x>=13.6.0 ; extra == 'cupy-cuda13x'
Requires-Dist: qutip>=5.0.3.post1 ; extra == 'models'
Requires-Dist: scqubits>=4.2 ; extra == 'models'
Requires-Python: >=3.11
Provides-Extra: cupy-cuda11x
Provides-Extra: cupy-cuda12x
Provides-Extra: cupy-cuda13x
Provides-Extra: models
Description-Content-Type: text/markdown

# ${\rm qCH_{eff}}$
${\rm qCH_{eff}}$ (/kju ʃɛf/) calculates effective Hamiltonians for quantum systems.
# Getting Started
 ${\rm qCH_{eff}}$ can be installed using `pip`:
```sh
pip install qcheff
 ```

Detailed installation instruction are [provided here](user_guide/install.md). CuPy is required in order to use the GPU for computations. 

# Contributing

We use the permissive [MIT](https://choosealicense.com/licenses/mit/) license. Pull requests are welcome. For major changes, please open a GitHub issue first to discuss what you would like to change. Please make sure to update tests as appropriate. More developer documentation is available [here](developer_docs/index).

# Citing ${\rm qCH_{eff}}$ 
 If you use ${\rm qCH_{eff}}$  in your work, please cite our [paper](https://arxiv.org/abs/2411.09982): 

```bibtex
@article{qcheff2025,
      title={GPU-accelerated Effective Hamiltonian Calculator}, 
      author={Abhishek Chakraborty and Taylor L. Patti and Brucek Khailany and Andrew N. Jordan and Anima Anandkumar},
      year={2025},
      eprint={2411.09982},
      archivePrefix={arXiv},
      primaryClass={quant-ph},
      url={https://arxiv.org/abs/2411.09982}, 
}

```

