https://github.com/cako/pycurvelablops
Thin PyLops wrapper for PyCurvelab
https://github.com/cako/pycurvelablops
Last synced: 8 months ago
JSON representation
Thin PyLops wrapper for PyCurvelab
- Host: GitHub
- URL: https://github.com/cako/pycurvelablops
- Owner: cako
- License: mit
- Created: 2020-10-11T19:44:33.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-16T03:47:23.000Z (over 5 years ago)
- Last Synced: 2025-09-29T05:03:08.041Z (9 months ago)
- Language: Python
- Size: 46.5 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/py/pyctlops)
# PyCurvelabLops
Thin [PyLops](https://pylops.readthedocs.io/) wrapper for [PyCurvelab](https://github.com/slimgroup/PyCurvelab). Don't know what PyLops is? PyLops provides a framework for performing matrix-free linear operations. This package provides a `LinearOperator` for performing the FDCT in 2D and 3D (contained in the PyCurvelab package) which works seamlessly with other PyLops operators.
## Installation
Installing PyCurvelabLops requires the following components:
- [FFTW](http://www.fftw.org/download.html) 2.1.5
- [CurveLab](http://curvelet.org/software.html) >= 2.0.2
- [SWIG](http://www.swig.org/) >= 1.3
- [PyCurvelab](https://github.com/slimgroup/PyCurvelab)
All of these packages *must be installed manually*. See more information below.
After these are installed, you may install PyCurvelabLops with:
```bash
pip install pyctlops
```
## Get Started
Start with:
```python
import pyctlops
```
An excellent place to see how to use the library is the `examples/` folder. `Demo_Single_Curvelet` for example contains a `pyctlops` version of the CurveLab Matlab demo.
## Tips and Tricks for Dependencies
### FFTW
For FFTW 2.1.5, you must compile with position-independent code support. Do that with
```bash
./configure --with-pic --prefix=/home/user/opt/fftw-2.1.5 --with-gcc=/usr/bin/gcc
```
The `--prefix` and `--with-gcc` are optional and determine where it will install FFTW and where to find the GCC compiler, respectively.
### CurveLab
In the file `makefile.opt` set `FFTW_DIR`, `CC` and `CXX` variables as required in the instructions. To keep things consistent, set `FFTW_DIR=/home/user/opt/fftw-2.1.5` (or whatever directory was used in the `--prefix` option). For the others, use the same compiler which was used to compile FFTW.
### PyCurvelab
You must ensure that `FFTW` and `FDCT` enviroment variables are set. In Bash, this is done with
```bash
export FFTW=/home/user/opt/fftw-2.1.5
export FDCT=/home/user/opt/CurveLab-2.1.3
```
Then enter the PyCurvelab directory and run
```bash
python3 setup.py build install --record files.txt
```
This installation has been tested against Python 3.6 and 3.7.
If it complains of a missing `Python.h` file, you must install the Python header files. In Ubuntu, you can try
```bash
sudo apt install python3.6-dev
```
To ensure that it has been installed, open you python interpreter and try to `import pyct`. If you get the following error
```bash
ModuleNotFoundError: No module named '_fdct2_wrapper'
```
try
```bash
export PYTHONPATH=/path/to/my/python3
```
In my experience this is only required in virtual environments and only for the first import but YMMV.