Getting Started

This section will guide you through installing, setting up, and launching xregGUI.

The critical components for the software include (1) the GUI and (2) the xreg executables

The xreg GUI can be acquired in through the following ways:
- Build from source (see Getting the GUI: from Source)
- Download a pre-built distribution (see Getting the GUI: from a Pre-built Distribution)
The xreg executables can be acquired in through the following ways:
- Build from source (see Getting the xreg executables: build from Source)
- Download a pre-built distribution (see Getting the xreg executables: from a Pre-built Distribution)

Getting the GUI: from Source

Clone the repository:

git clone https://github.com/jhu-bigss/xreg_ws.git
cd xreg_ws

Install Python dependencies:
```
pip install -r requirements.txt
```
Set the ``XREG_BUILD_DIR`` environment variable:

This should point to the directory containing your xreg binaries.
```
export XREG_BUILD_DIR=/path/to/xreg/build
```

Prepare your working directory:

Organize your data as follows:

xreg_ws/
  gui/
  meta_data/
    XrayDICOM/
    landmarks/
    models/
  outputs/
  configs/
  logs/

We provide a pre-built distribution for the GUI. You can download it from the release page from the github repository. [link](https://github.com/jhu-bigss/xreg_ws/releases/)
Unzip the package and run the executable.

The xreg repository is located at: https://github.com/jhu-bigss/xreg, please follow the instructions in the README.md file to build the xreg executables.
```
git clone https://github.com/jhu-bigss/xreg.git
```
Alternatively, we provide a docker build script to build the xreg executables. Currently only a docker configuration for Ubuntu 22.04 is provided.
```
cd xreg/docker_ubuntu_22.04
chmod +x ./example_commands.sh
./example_commands.sh
```

This works the same as the GUI from a pre-built distribution, please navigate to the release page from the github repository. [link](https://github.com/jhu-bigss/xreg/releases/)
Unzip the package and run the executable. The executable is located in the build/ directory.

Note

If you encounter issues, check the Troubleshooting section.