mbirjax 0.1.0

High-performance tomographic reconstruction

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

Installing

1. Clone or download the repository:

   git clone [e-mail]:cabouman/mbirjax.git

2. Install the conda environment and package

   1. Option 1: Clean install from dev_scripts

      *****You can skip all other steps if you do a clean install.****

      To do a clean install, use the command:

      cd dev_scripts
      source clean_install_all.sh

   2. Option 2: Manual install

      1. Create conda environment:

         Create a new conda environment named mbirjax using the following commands:

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

         Anytime you want to use this package, this mbirjax environment should be activated with the following:

         conda activate mbirjax

      2. Install mbirjax package:

         Navigate to the main directory mbirjax/ and run the following:

         pip install .

         To allow editing of the package source while using the package, use

         pip install -e .

Running Demo(s)

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

python demo/<demo_file>.py