Skip to main content

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

Project description

RegPy: Python tools for regularization methods

GitHub release (latest by date) DOI Read the Docs

PyPI PyPI - Implementation

GitHub Workflow Status GitHub Workflow Status

PyPI - Downloads Docker Pulls

RegPy is a Python library developed at the Institute for Numerical and Applied Mathematics at the University of Göttingen. It provides tools to implement custom forward models -- both linear and non-linear -- as well as a variety of regularization methods and stopping rules.

This project is currently approaching beta quality state, but remains under active development. As a result, you may run into bugs or partially undocumented features. If you run into any issues we welcome any information on our GitHub issue tracker.

Detailed information and documentation of the current version can be found at https://num.math.uni-goettingen.de/regpy/.

Usage examples

We offer an explanation on how to use RegPy here and our website features several detailed usage examples. These examples are provided as Jupyter notebooks that serve as a tutorial-style introduction to RegPy.

For a more comprehensive overview of RegPy's capabilities, we provide numerous examples in the examples GitHub repository. These examples are also part of the docker image provided on DockerHub (see in the installation instructions for details). Most examples include both a commented Python script and a Jupyter notebook with more detailed explanations.

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.
  • matplotlib (for some of the examples)
  • sphinx (for generating the documentation) further requirements in doc/sphinx/requirements.txt

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

regpy-1.1.0.tar.gz (904.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

regpy-1.1.0-py3-none-any.whl (223.2 kB view details)

Uploaded Python 3

File details

Details for the file regpy-1.1.0.tar.gz.

File metadata

  • Download URL: regpy-1.1.0.tar.gz
  • Upload date:
  • Size: 904.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for regpy-1.1.0.tar.gz
Algorithm Hash digest
SHA256 39b223809f8b28f21e062e29d41decb8c082c2843fe21b01d1810805857fa244
MD5 005649470c269368d50628ec1a4e0f50
BLAKE2b-256 d2df4c78c8094def951af1d5028f7f48946cc688772d9e919be42ac8841e575f

See more details on using hashes here.

Provenance

The following attestation bundles were made for regpy-1.1.0.tar.gz:

Publisher: pypi.yml on regpy/regpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file regpy-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: regpy-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 223.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for regpy-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e696d7bd5576eb919b96d9d80c1d2f4dc289355a329b0903bc7d19acebc07c0
MD5 5a40ce8da31cb1a5266595f5ee24abcd
BLAKE2b-256 b6c9ad80b67a1361bc808ccf175317a96ff16681e70578c5a8d96bf9d06371c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for regpy-1.1.0-py3-none-any.whl:

Publisher: pypi.yml on regpy/regpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page