Metadata-Version: 2.4
Name: qugradlab
Version: 0.2.0
Summary: An extension to the Python package QuGrad that implements common Hilbert space structures, Hamiltonians, and pulse shapes for quantum control.
Project-URL: Homepage, https://github.com/Christopher-K-Long/QuGrad
Project-URL: Documentation, https://QuGrad.readthedocs.io/
Project-URL: Issues, https://github.com/Christopher-K-Long/QuGrad/issues
Project-URL: Changelog, https://github.com/Christopher-K-Long/QuGrad/blob/main/ChangeLog.md
Author: Henrik Gothen, Crispin H. W. Barnes, David R. M. Arvidsson-Shukur, Normann Mertig
Author-email: "Christopher K. Long" <ckl45@cam.ac.uk>
Maintainer-email: "Christopher K. Long" <ckl45@cam.ac.uk>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: Hamiltonian,control,pulse
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Quantum Computing
Requires-Python: >=3.9
Requires-Dist: numpy<3,>=1.21
Requires-Dist: py-ste==1.*
Requires-Dist: qugrad==1.*
Requires-Dist: scipy==1.*
Requires-Dist: tensorflow==2.*
Description-Content-Type: text/markdown

# QuGradLab
An extension to the Python package [QuGrad](https://QuGrad.readthedocs.io) ([doi:10.5281/zenodo.17116721](https://doi.org/10.5281/zenodo.17116721)) that implements common Hilbert space structures, Hamiltonians, and pulse shapes for quantum control.

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17116725.svg)](https://doi.org/10.5281/zenodo.17116725) [![SWH](https://archive.softwareheritage.org/badge/origin/https://doi.org/10.5281/zenodo.17116725/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://doi.org/10.5281/zenodo.17116725) [![Unit Tests](https://github.com/Christopher-K-Long/QuGradLab/actions/workflows/test-python-package.yml/badge.svg)](https://github.com/Christopher-K-Long/QuGradLab/actions/workflows/test-python-package.yml)

## Installation

The python package can be installed with pip as follows:
```bash
pip install qugradlab
```

If on Linux and using a conda environment you may encounter an error
```
version `GLIBCXX_...' not found
```
to fix this you also need to execute:
```bash
conda install -c conda-forge libstdcxx-ng
```

### Requirements

Requires:
- [QuGrad](https://QuGrad.readthedocs.io) (== 1.*) ([doi:10.5281/zenodo.17116721](https://doi.org/10.5281/zenodo.17116721))
- [PySTE](https://PySTE.readthedocs.io) (== 1.*) ([doi:10.5281/zenodo.17116431](https://doi.org/10.5281/zenodo.17116431))
- [TensorFlow](https://www.tensorflow.org) (== 2.*)
- [NumPy](https://numpy.org) (>= 1.21, < 3)
- [SciPy](https://scipy.org/) (== 1.*)

#### Additional requirements for testing

- [toml](https://github.com/uiri/toml)
- [PyYAML](https://pyyaml.org/)

## Documentation

Documentation, including worked examples can be found at: [https://QuGradLab.readthedocs.io](https://QuGradLab.readthedocs.io)

## Source Code

Source code can be found at: [https://github.com/Christopher-K-Long/QuGradLab](https://github.com/Christopher-K-Long/QuGradLab)

A mirror can be found at: [https://gitlab.com/Christopher-K-Long/QuGradLab](https://gitlab.com/Christopher-K-Long/QuGradLab)

Please submit all [pull requests](https://github.com/Christopher-K-Long/QuGradLab/pulls), [issues](https://github.com/Christopher-K-Long/QuGradLab/issues), [discussions](https://github.com/Christopher-K-Long/QuGradLab/discussions), and [vulnerability reports](https://github.com/Christopher-K-Long/QuGradLab/security) to the [GitHub](https://github.com/Christopher-K-Long/QuGradLab) repository.

Releases from this repository are assigned DOIs and  can be found at [https://doi.org/10.5281/zenodo.17116725](https://doi.org/10.5281/zenodo.17116725). The DOI for all releases is [10.5281/zenodo.17116725](https://doi.org/10.5281/zenodo.17116725). Additionally, the releases are archived to [https://archive.softwareheritage.org/swh:1:dir:66eaab3efbc90a0188c5851565b6bfb663bbfe39](https://archive.softwareheritage.org/swh:1:dir:66eaab3efbc90a0188c5851565b6bfb663bbfe39).

## Version and Changes

The current version is [`0.2.0`](ChangeLog.md#release-020). Please see the [Change Log](ChangeLog.md) for more details. QuGradLab uses [semantic versioning](https://semver.org/).