Skip to main content

MBIRJAX

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

Metadata

Release files for mbirjax 0.7.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mbirjax 0.7.3
File Size Uploaded
mbirjax-0.7.3.tar.gz 585.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mbirjax 0.7.3
File Interpreter ABI Platform
mbirjax-0.7.3-py3-none-any.whl Python 3 none any Details

Total release size: 1.1 MB

Release files / mbirjax-0.7.3.tar.gz

Download URL mbirjax-0.7.3.tar.gz
Size 585.9 kB
Tags Source
SHA-256 checksum
How to use checksums
23a154ffb8d377b7497f892b9b049facff6aca7adc1b84b202477e2a7bcf9433
BLAKE2b-256 checksum
How to use checksums
8db42de9738370309f8b169672bfb4717557308ffeeb71d61cc313349a3aaf03
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Release files / mbirjax-0.7.3-py3-none-any.whl

Download URL mbirjax-0.7.3-py3-none-any.whl
Size 554.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bba02ce962c2954587db92762d6733b4b5d6074d6b0737412efb5bf18da2ed8f
BLAKE2b-256 checksum
How to use checksums
cebb3b8c0e3b2bcb916080aaad2b100b06364e624cf4edd9c08411264fe046dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

0.7.3 This release

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.16

2 release files

0.6.15

2 release files

0.6.14

2 release files

0.6.13

2 release files

0.6.11

2 release files

0.6.9

2 release files

0.6.8

2 release files

0.6.7

2 release files

0.6.6

2 release files

0.6.5

2 release files

0.6.4

2 release files

0.6.3

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page