Metadata-Version: 2.4
Name: GEOPE
Version: 0.0.4
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: jax==0.8.0
Requires-Dist: optax==0.2.4
Requires-Dist: numpy==2.4.6
Requires-Dist: scipy==1.17.1
Requires-Dist: pandas==2.3.3
Provides-Extra: dev
Requires-Dist: pre-commit==3.7.0; extra == "dev"
Requires-Dist: pytest==9.0.3; extra == "dev"
Requires-Dist: pytest-benchmark==5.1.0; extra == "dev"
Requires-Dist: black==24.3.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: matplotlib==3.10.7; extra == "docs"
Requires-Dist: pytest==9.0.3; extra == "docs"
Requires-Dist: mkdocs==1.6.1; extra == "docs"
Requires-Dist: mkdocs-material==9.6.23; extra == "docs"
Requires-Dist: mkdocstrings==0.30.1; extra == "docs"
Requires-Dist: mkdocs-exclude==1.0.2; extra == "docs"
Requires-Dist: mkdocs-ipynb==0.1.1; extra == "docs"
Requires-Dist: hippogriffe==0.2.2; extra == "docs"
Dynamic: license-file

# GEOPE

[![Tests](https://github.com/dyylan/geope/actions/workflows/tests.yml/badge.svg)](https://github.com/dyylan/geope/actions/workflows/tests.yml)
[![PyPI](https://img.shields.io/pypi/v/geope)](https://pypi.org/project/geope/)
[![Docs](https://img.shields.io/badge/docs-online-blue)](https://dyylan.github.io/geope)

**GEOPE** (Geodesic Pulse Engineering) is a Python library for quantum gate synthesis using Lie algebraic and geodesic optimisation methods built on [JAX](https://github.com/jax-ml/jax).

## Installation

Install the latest release from [PyPI](https://pypi.org/project/geope/) (Python 3.11+):

```bash
pip install geope
```

### From source (development)

```bash
git clone https://github.com/dyylan/geope.git
cd geope
pip install -e ".[dev]"
```

## Documentation

Full API documentation is available at [dyylan.github.io/geope](https://dyylan.github.io/geope).

## References

The methods implemented in GEOPE are described in:

- D. Lewis, R. Wiersema, and S. Bose, *Quantum Optimal Control with Geodesic Pulse Engineering*, [arXiv:2508.16029](https://arxiv.org/abs/2508.16029) (2025) — the geodesic pulse engineering method.
- D. Lewis and R. Wiersema, *Pulse Quality Optimisation in Quantum Optimal Control*, [arXiv:2604.25768](https://arxiv.org/abs/2604.25768) (2026) — the Gecko pulse quality optimisation method.
