<div align="center">

<img src="docs/img/gropt_logo.png" alt="GrOpt" width="200">

**Gradient waveform optimization for MRI pulse sequence design**

[![Build](https://github.com/cmr-group/gropt-dev/actions/workflows/build-and-publish.yml/badge.svg)](https://github.com/cmr-group/gropt-dev/actions/workflows/build-and-publish.yml)
[![PyPI](https://img.shields.io/pypi/v/gropt)](https://pypi.org/project/gropt/)
[![Python](https://img.shields.io/pypi/pyversions/gropt)](https://pypi.org/project/gropt/)

</div>

---

## Installation

```bash
pip install --pre gropt
```

> **Note:** GrOpt 2.0 is currently in pre-release. The `--pre` flag is required to install it for now.

## Documentation

See the [documentation site](https://cmr-group.github.io/gropt-dev/) and the [`examples/`](./examples/) folder to get started.
