Installation Guide

Note: This documentation is a work in progress and subject to further improvements.

---

1. Requirements

Before installing, make sure you have: - Python \(\ge 3.7\) - CMake \(\ge 3.16\) - A C++17 compiler (e.g. GCC or Clang)

---

2. Install in an Isolated Environment

Using an isolated virtual environment prevents conflicts with other Python packages:

# 1. Clone this repository (copy URL from the green "Code" button on GitHub)
git clone https://github.com/shimlab/WaveFactor.git
cd WaveFactor

# 2. Create and activate a virtual environment
python3 -m venv wavefactor-venv
source wavefactor-venv/bin/activate

# 3. Install WaveFactor
pip install .

Warning if installing into multiple environments or reinstalling, we recommend deleting the build folder created after every installation before starting a new installation so as to avoid potential conflicts with installation artifacts.

---

3. (Optional) Check Installation Succeeded

Check that the installation succeeded:

pip show wavefactor

---

4. (Optional) Deactivate or Remove

Deactivate the virtual environment by:

deactivate

After deactivation, to completely delete the installation, just remove the wavefactor-venv/ folder:

rm -rf wavefactor-venv