CUQIpy-User-Showcase

Welcome to the CUQIpy User Showcase Repository, where a diverse collection of practical applications is generously contributed by our enthusiastic CUQIpy users. While some entries have undergone minor edits by CUQIpy maintainers to enhance clarity, full credit for the contents is attributed to their original authors.

List of notebooks

• 001 Besov 2D deblurring custom prior, deconvolution, gradient-based

• 002 Eigenvalue forward custom forward, custom sampler, independence sampler

• 003 Error model deconvolution

• 004 Besov 1D deconvolution custom prior, deconvolution, gradient-based

• 005 Implicit priors implicit prior, regularized Gaussian, deconvolution, linearRTO

• 006 Plug-and-play priors implicit prior, neural network, denoiser, deconvolution, linearRTO

• 007 Smoothed Laplace custom prior, gradient-based, deconvolution

• 008 Delayed acceptance custom forward, custom sampler, ODE

• 009 Inverse Robin custom forward, finite element, _gradientbased

• 010 Spring system custom forward, MH sampler

• 011 Fusion plasma tomography custom forward, custom prior, linearRTO

• 012 Super resolution custom forward, custom prior, _gradientbased, CUQIpy-PyTorch

Contribution Guidelines

If you're interested in contributing to this repository by adding your notebook, we encourage you to submit a pull request. Your contributions are immensely valuable to us!

To contribute a new notebook to the repository, please follow these step-by-step instructions:

1. Begin by creating a fork of the repository and then initiate a new branch.
2. Establish a new folder that encompasses your contributions, presented as Jupyter notebooks, along with any necessary supporting Python files, and a LICENSE file.
   • Include a descriptive summary of your contribution at the top of your notebook.
   • Display the CUQIpy version by printing it.
   • Incorporate a license header, selecting a license of your preference.
3. Subsequently, open a pull request for the CUQIpy maintainer team to review. When initiating the pull request, please ensure to check the box that says "Allow edits from maintainers."

The CUQIpy maintainer team will thoroughly review your contribution and may provide feedback for minor adjustments or make some small changes to your fork. We appreciate your commitment to enhancing the CUQIpy community!