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.1.tar.gz (560.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.1-py3-none-any.whl (533.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mbirjax-0.7.1.tar.gz
  • Upload date:
  • Size: 560.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.1.tar.gz
Algorithm Hash digest
SHA256 fdd576f634f5b13aca091adcbb324d7a34ee95b90c3f52d017850d1d5d7f6c8e
MD5 2bc9ea4d5a6c63ddec50e758d661248f
BLAKE2b-256 aff6b3dc50540524bac952efc4e204ed659d3d6ebde522c635a36ce09f47676e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mbirjax-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 533.3 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1a8c17b5a58b4891d37f933c61457a3408ab51f90ff01dc4e64a7eed97981b28
MD5 46408352eaac5cf1f24af5239dbfae83
BLAKE2b-256 faeef589ca95cc5d2dade268eebb4f360d8ea098cce20c983e412cefd43f354c

See more details on using hashes here.

Release history Release notifications | RSS feed

0.7.2

2 files

This release

0.7.1 This release

2 files

0.7.0

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