Variationally Reweighted Least Squares

This repository is a proving ground for the variationally reweighted least squares (VRLS) algorithm, in the specialized context of nonuniformly sampled nuclear magnetic resonance (NUS NMR) acquisition.

Building

To build the vrls-nmr extension module, you will need PyTorch and a complete compiler toolchain,

pip install torch pybind11

and then build and install the module:

python3 setup.py build
python3 setup.py bdist_wheel
pip install dist/*whl

Running make or make build will run the same steps.

Testing

A small set of unit tests is available in the test directory and may be executed using pytest:

pip install pytest
pytest test

Notebooks

Analyses in the notebooks directory may be opened using marimo:

pip install marimo
cd notebooks/
marimo edit param-tuning.py

Licensing

The vrls-nmr extension module is released under the MIT license. See the LICENSE.md file for the complete license terms.