regpy 0.4.1.post1.dev1

A python library to solve Inverse and Ill-Posed problems by regularization

regpy: Python tools for regularization methods

RegPy is a python library for implementing and solving ill-posed inverse problems developed at the Institute for Numerical and Applied Mathematics Goettingen. It provides tolls to implement your own forward model both linear and non-linear and a variety of regularization methods that can be stopped using common stopping rules.

This project is currently in an almost beta quality state. However, the project is still under intensive development. Therefore, expect bugs and partially undocumented tools. If you encounter any issues we welcome any information on our github issue tracker.

For the current version we provide information and a detailed documentation under https://num.math.uni-goettingen.de/regpy/.

Usage examples

We provide a explanation on how to use RegPy here. On our website we provide some usage examples. These examples are jupyter notebooks that should provide a tutorial kind of introduction to the usage of RegPy.

To get an full impression of the usage of RegPy, we provide many examples in the examples folder on GitHub, as well as inside the release tarballs (see below). Most of the examples supply both a commented python script and a python notebook with more detailed explanation.

Installation

We provide different installation methods, such installation using pip, listed and explained in INSTALLATION.md.

Dependencies

• numpy >= 1.14
• scipy >= 1.1

Optional dependencies

• ngsolve, for some forward operators that require solving PDEs. We provide an optional installation tag ngsolve when installing with pip.
• bart (for the MRI operator)
• matplotlib (for some of the examples)
• sphinx (for generating the documentation) further requirements in doc/sphinx/requirements.txt.