Skip to content

Add Windows instructions, and update the example script #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zipy124 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add Windows instructions, and update the example script #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d84099
Update README.md
zipy124 Jul 24, 2025
6c731a6
Update example.py
zipy124 Jul 24, 2025
bdb21da
Update example.py
zipy124 Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ PyLBFGS is a Python 3 wrapper of the [libLBFGS][libLBFGS] library -- a C port (w

At this time, only the Orthant-Wise Limited-memory Quasi-Newton (OWL-QN) algorithm is exposed (although very little work would be required to expose the full [libLBFGS][libLBFGS] implementation).

Also note that PyLBFGS has only been compiled and tested with Python 3 on a 64-bit Ubuntu machine. It should work in other environments... but tweaking the installation commands is a task left to the reader.
Also note that PyLBFGS has only been compiled and tested with Python 3 on a 64-bit Ubuntu machine and a 64-bit Windows machine. It should work in other environments... but tweaking the installation commands is a task left to the reader.

In order to compile on Windows one simply has to remove the "runtime_library_dirs" line in setup.py, and modify the library/include dirs to point to your install. You must also add the x64 build target when building libLBFGS in visual studio if compiling for a x64 machine and version of python.


Install
Expand All @@ -27,7 +28,7 @@ Install

3. Setup and activate a virtual environment (modify the Python version if necessary):

virtualenv -p python3.6 --prompt="(pylbfgs) " .venv
virtualenv -p python3.12.9 --prompt="(pylbfgs) " .venv
. .venv/bin/activate

4. Install the project:
Expand Down Expand Up @@ -83,7 +84,7 @@ Examples

See the *example.py* script for an advanced example in which we use compressed sensing to reconstruct a sparsely sampled image. A more thorough example of compressed sensing (using PyLBFGS) can be found on my weblog [here][blog_post].

pip install Pillow==5.0.0 scipy==1.0.0 matplotlib==2.1.2
pip install Pillow==11.1.0 scipy==1.15.2 matplotlib==3.1.0
python example.py


Expand Down
15 changes: 10 additions & 5 deletions example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import numpy as np
import scipy.fftpack as spfft
import scipy.ndimage as spimg
import imageio
import matplotlib.pyplot as plt
from pylbfgs import owlqn

Expand Down Expand Up @@ -178,8 +179,12 @@ def main():

global _b_vector, _A_matrix, _image_dims, _ri_vector

# read image in grayscale, then downscale it
Xorig = spimg.imread(ORIG_IMAGE_PATH, flatten=True, mode='L')
# read image in, then convert to grayscale and then downscale it
Xorig = imageio.imread(ORIG_IMAGE_PATH)
# Cast to float before grayscale conversion
Xorig = Xorig.astype(float)
# Preserving the behaviour of mode='L' from the deprecated scipy.ndimage.imread
Xorig = Xorig[:, :, 0] * 299/1000 + Xorig[:, :, 1] * 587/1000 + Xorig[:, :, 2] * 114/1000
X = spimg.zoom(Xorig, SCALE)
ny, nx = X.shape

Expand Down Expand Up @@ -264,9 +269,9 @@ def main():

# display the result
f, ax = plt.subplots(1, 3, figsize=(14, 4))
ax[0].imshow(X, cmap='hot', interpolation='none')
ax[1].imshow(Xm, cmap='hot', interpolation='none')
ax[2].imshow(Xa, cmap='hot', interpolation='none')
ax[0].imshow(X, cmap='hot', interpolation='none',vmin=0, vmax=255)
ax[1].imshow(Xm, cmap='hot', interpolation='none',vmin=0, vmax=255)
ax[2].imshow(Xa, cmap='hot', interpolation='none',vmin=0, vmax=255)
plt.show()


Expand Down