Metadata-Version: 2.4
Name: svmbir
Version: 0.5.0
Summary: Python code for fast parallel-beam MBIR (Model Based Iterative Reconstruction)
Maintainer-email: "Charles A. Bouman" <charles.bouman@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/cabouman/svmbir
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.26.0
Requires-Dist: psutil>=5.8
Requires-Dist: Pillow>=12.3.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruamel.yaml; extra == "dev"
Requires-Dist: Cython; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-book-theme>=1.0.1; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Provides-Extra: demo
Requires-Dist: matplotlib; extra == "demo"
Dynamic: license-file

# svmbir

*Python code for fast MBIR (Model Based Iterative Reconstruction)  
This is a python wrapper for the supervoxel C code [sv-mbirct](https://github.com/HPImaging/sv-mbirct) written by High Performance Imaging, a copy of which is in this repository.*

Full documentation is available at [svmbir_docs](https://svmbir.readthedocs.io).

To cite this software package, please use the bibtext entry at [cite_svmbir](https://svmbir.readthedocs.io/en/latest/credits.html#references).

## Installing svmbir

Currently supporting Python 3.10 or later, on MacOS and Linux (Windows possible but not actively maintained).

**svmbir** packages are available from conda-forge and PyPI, or can be built and installed from source.

- (recommended) Create a clean virtural environment, such as

```
conda create -n svmbir python=3.10
conda activate svmbir
```

- To install from conda-forge,

```
conda install -c conda-forge svmbir
```

- To install from PyPI,

```
pip install svmbir
```

- Installing from source (Linux: gcc; MacOS: clang plus `conda install -c conda-forge llvm-openmp`; see the [install page](https://svmbir.readthedocs.io/en/latest/install.html)),

```
# In top repository folder,
pip install .
```

See [here](https://svmbir.readthedocs.io/en/latest/install.html#)
for more details.



## Running the demos
1. Clone the repository (see above) and change into its `demo` folder.
2. In your terminal window, install the demo dependencies.
```
pip install "svmbir[demo]"
```
3. In your terminal window, use python to run each demo.




