User Guide

Welcome to the user guide for CUQIpy!

The main resources for users are structured as follows.

• Getting started

  Get CUQIpy up and running on your system and learn the basics.

• How-To Guides

  To solve a specific task/problem using CUQIpy. How-to guides are more in-depth guides for specific features of CUQIpy. They are recipes for how to do a specific thing and assume a basic understanding of CUQIpy.

• API Reference

  To see documentation of the CUQIpy API. This contains an overview of all the modules, classes and methods in CUQIpy.

• CUQI Book

  CUQI Book provides a more detailed exposition of the theory and algorithms underlying CUQIpy, along with guidance on its use and selected research applications.

• Papers and citation

  To find the official CUQIpy papers to cite and a list of papers that use CUQIpy.

There are also a large number of demos and examples in the cuqipy/demos directory. The goal is to ultimately integrate these into the user guide.