Skip to main content

SPGL1: A solver for large-scale sparse reconstruction.

Project description

SPGL1: Spectral Projected Gradient for L1 minimization

Build Status PyPI version Documentation Status

Original home page: http://www.cs.ubc.ca/labs/scl/spgl1/

Introduction

SPGL1 is a solver for large-scale one-norm regularized least squares.

It is designed to solve any of the following three problems:

  1. Basis pursuit denoise (BPDN): minimize ||x||_1 subject to ||Ax - b||_2 <= sigma,

  2. Basis pursuit (BP): minimize ||x||_1 subject to Ax = b

  3. Lasso: minimize ||Ax - b||_2 subject to ||x||_1 <= tau,

The matrix A can be defined explicitly, or as an operator that returns both both Ax and A'b.

SPGL1 can solve these three problems in both the real and complex domains.

Installation

From PyPi

If you want to use spgl1 within your codes, install it in your Python environment by typing the following command in your terminal:

pip install spgl1

From Source

First of all clone the repo. To install spgl1 within your current environment, simply type:

make install

or as a developer:

make dev-install

To install spgl1 in a new conda environment, type:

make install_conda

or as a developer:

make dev-install_conda

Getting started

Examples can be found in the examples folder in the form of jupyter notebooks.

Documentation

The official documentation is built with Sphinx and hosted on readthedocs.

References

The algorithm implemented by SPGL1 is described in these two papers

  • E. van den Berg and M. P. Friedlander, "Probing the Pareto frontier for basis pursuit solutions", SIAM J. on Scientific Computing, 31(2):890-912, November 2008

  • E. van den Berg and M. P. Friedlander, "Sparse optimization with least-squares constraints", Tech. Rep. TR-2010-02, Dept of Computer Science, Univ of British Columbia, January 2010

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

spgl1-0.0.3.tar.gz (311.6 kB view details)

Uploaded Source

Built Distribution

spgl1-0.0.3-py3-none-any.whl (292.1 kB view details)

Uploaded Python 3

File details

Details for the file spgl1-0.0.3.tar.gz.

File metadata

  • Download URL: spgl1-0.0.3.tar.gz
  • Upload date:
  • Size: 311.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for spgl1-0.0.3.tar.gz
Algorithm Hash digest
SHA256 9734da2747de5a48d65021f286ad1f1ba42503a5b3277b9fa052cfda1858530b
MD5 5be6498ec7a578af14ae9e58fd240953
BLAKE2b-256 a63c19c65d94fc402f208db8a917a8c8d8b16e4b62adc3b34095291ad9d5d30f

See more details on using hashes here.

File details

Details for the file spgl1-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: spgl1-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 292.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for spgl1-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fe60db8a389e149d7f3016a019d6feb0ab3f4a17f407dffced25ff4ea7ccb1a3
MD5 b0e1511ba6c54f3dfbb6ff32c25a0641
BLAKE2b-256 96dc98d6e6efd31e0fe48b19da9a2e3241b2cd8c952c5bd3fe4411cae8aadfe7

See more details on using hashes here.

Supported by

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