How to get SIRF

We provide several different ways to install SIRF and 1 way to run it in the cloud, all with different advantages. They are roughly ordered from "user only" to "developer".

Note that the distributions below also give you access to STIR, although sometimes a bit more work is needed for full STIR functionality.

Running in GitHub Codespaces

You can run the SIRF-Exercises directly in the cloud without any set-up, if you have a GitHub account, see the SIRF-Exercises documentation.

Note that GitHub Codespaces are a great way to explore, but free for limited usage only.

A Docker container

Docker provides light-weight containers, more integrated with your own OS.

• Using a Python IDE is possible depending on your host OS, preferred IDE, and whether you need the IDE installed in the host, in the container, or both.
• See SIRF using Docker for more information, including installation instructions.

A Virtual Machine

Note: our VM is currently out-of-date. Hopefully we will be able to upload a new one soon.

A VM for VirtualBox running Ubuntu with everything pre-installed.

• Download/install/usage information

Devcontainer and Visual Studio Code

A devcontainer allows code development in an isolated environment.

• usage information

Building the software yourself

This will give you the most flexibility and best performance, but needs more work to get you going. Only try this if you know what you are doing...

• Installation instructions
• Rebuilding after upgrades

Conda

• STIR is on conda-forge, see instructions, but SIRF not yet. Coming soon!