Skip to main content

Model-Based Iterative Reconstruction (MBIR) for tomographic reconstruction that is based on the JAX library. Full documentation is available at https://mbirjax.readthedocs.io .

Installing from PyPI

For CPU only:

pip install mbirjax

For CPU with a CUDA12-enabled GPU:

pip install --upgrade mbirjax[cuda12]

Installing from Source

  1. Clone the repository:

    git clone git@github.com:cabouman/mbirjax.git
  2. Install the conda environment and package

    1. Option 1: Clean install using dev_scripts - We provide bash scripts that will do a clean install of MBIRJAX in a new conda environment using the commands:

      cd dev_scripts
      source clean_install_all.sh
    2. Option 2: Manual install - You can also manually install MBIRJAX from the main directory of the repository with the following commands:

      conda create --name mbirjax python=3.10
      conda activate mbirjax
      pip install -r requirements.txt
      pip install .

Optional Pixi Development Environment

For contributors who use Pixi, MBIRJAX also provides an optional reproducible development environment. This does not replace the conda installation workflow above.

For the default CPU environment on Linux or Apple Silicon macOS:

pixi run smoke
pixi run test-fast

For a CUDA-enabled Linux system:

pixi run -e cuda smoke-jax
pixi run -e cuda test-fast

Additional useful tasks include:

pixi run test
pixi run test-data
pixi run docs

Running Demo(s)

Run any of the available demo scripts with something like the following:

python demo/<demo_file>.py

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mbirjax-0.7.0.tar.gz (489.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mbirjax-0.7.0-py3-none-any.whl (484.4 kB view details)

Uploaded Python 3

File details

Details for the file mbirjax-0.7.0.tar.gz.

File metadata

  • Download URL: mbirjax-0.7.0.tar.gz
  • Upload date:
  • Size: 489.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for mbirjax-0.7.0.tar.gz
Algorithm Hash digest
SHA256 9b275545c882ab7925575ae941676aa90c3f3f27b6f2c93af9916c844d1b5ebf
MD5 96ae8bcdd697f73f251c688b2353f365
BLAKE2b-256 06a2344aa8100e7bf2cafc79a80c9643cecda16ba151fb62a722094f2912a650

See more details on using hashes here.

File details

Details for the file mbirjax-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: mbirjax-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 484.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for mbirjax-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 466e234947abbcdcaa3c9f981a1c971f05d2656730168631416098dce2581b8b
MD5 a8f596155aad1c56ce084b9ee61c0fa4
BLAKE2b-256 8a9b60a352b7c0bfa7ffdca438bf9224d140a4216f9b74153da7b869b07ea115

See more details on using hashes here.

Release history Release notifications | RSS feed

0.7.2

2 files

0.7.1

2 files

This release

0.7.0 This release

2 files

0.6.17.1

2 files

0.6.16

2 files

0.6.15

2 files

0.6.14

2 files

0.6.13

2 files

0.6.12

2 files

0.6.11

2 files

0.6.10

2 files

0.6.9

2 files

0.6.8

2 files

0.6.7

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page