Getting Started¶
System Requirements¶
ImputeGAP is compatible with Python>=3.10 (except 3.13) and Unix-compatible environment.
Installation/Update¶
To install the latest version of ImputeGAP from PyPI, run the following command:
pip install imputegap
If you would like to extend the library, you can install from source:
git init
git clone https://github.com/eXascaleInfolab/ImputeGAP
cd ./ImputeGAP
pip install -e .
ImputeGAP is compatible with Python>=3.10 (except 3.13) and Unix-compatible environment.
Install WSL
To run ImputeGAP in a Unix-compatible environment on Windows, install the Windows Subsystem for Linux (WSL).
Search for
WSLin the Start menu to check if it’s already installed.If not, open
PowerShellasAdministrator.Run the following command:
wsl --install
Restart your computer once the installation completes.
Prepare Python 3.12 Environment
To ensure a proper Python setup, we recommend creating a dedicated Python environment for the project. Python 3.12 is a suitable and supported choice.
Step 1: Check Existing Python Version
Open your terminal and check the currently installed version of Python:
python3 --version
Step 2: Install Python 3.12
If needed, install Python 3.12 on your WSL system, follow these steps:
Update your package list and install prerequisites:
sudo apt-get update
sudo apt install -y build-essential libssl-dev zlib1g-dev libncurses5-dev libncursesw5-dev \
libreadline-dev libsqlite3-dev libgdbm-dev libdb5.3-dev libbz2-dev libexpat1-dev liblzma-dev \
tk-dev python3-tk libopenblas0 software-properties-common python3-pip
Add the deadsnakes PPA and update:
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
Install Python 3.12:
sudo apt-get install python3.12 python3.12-venv python3.12-dev
Verify the installation:
python3.12 --version
Install Python 3.12 Environment
Create a virtual environment:
python3.12 -m venv imputegap_env
Activate the virtual environment:
source imputegap_env/bin/activate
Install ImputeGAP
pip install imputegap
Prepare Python 3.12 Environment
To ensure a proper Python setup, we recommend creating a dedicated Python environment for the project. Python 3.12 is a suitable and supported choice.
Step 1: Check Existing Python Version*
Open your terminal and check the currently installed version of Python:
python3 --version
*Step 2: Install Python 3.12
If needed, install Python 3.12 on your system, follow these steps:
Update your package list and install prerequisites:
sudo apt-get update
sudo apt install -y build-essential libssl-dev zlib1g-dev libncurses5-dev libncursesw5-dev \
libreadline-dev libsqlite3-dev libgdbm-dev libdb5.3-dev libbz2-dev libexpat1-dev liblzma-dev \
tk-dev python3-tk libopenblas0 software-properties-common python3-pip
Add the deadsnakes PPA and update:
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
Install Python 3.12:
sudo apt-get install python3.12 python3.12-venv python3.12-dev
Verify the installation:
python3.12 --version
Install Python 3.12 Environment
Create a virtual environment:
python3.12 -m venv imputegap_env
Activate the virtual environment:
source imputegap_env/bin/activate
Install ImputeGAP
pip install imputegap
Prepare Python 3.12 Environment
To ensure a proper Python setup, we recommend creating a dedicated Python environment for the project. Python 3.12 is a suitable and supported choice.
Install Homebrew (if not already installed):
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Update Homebrew and install Python 3.12:
brew update
brew install python@3.12
Verify the installation:
python3.12 --version
Install Python 3.12 Environment
Create a virtual environment:
python3.12 -m venv imputegap_env
Activate the virtual environment:
source imputegap_env/bin/activate
Install ImputeGAP
pip install imputegap
Docker¶
You can download the latest version of ImputeGAP as a Docker container, pre-configured with Jupyter Notebook and all required dependencies.
Launch Docker and make sure it is running:
docker version
Pull the ImputeGAP Docker image:
docker pull qnater/imputegap:0.0.8
Run the Docker container:
docker run -p 8888:8888 qnater/imputegap:0.0.8
Launch Docker and make sure it is running:
docker version
Pull the ImputeGAP Docker image:
docker pull qnater/imputegap:0.0.8
Run the Docker container:
docker run -p 8888:8888 qnater/imputegap:0.0.8
Launch Docker and make sure it is running:
docker version
Pull the ImputeGAP Docker image:
docker pull --platform linux/x86_64 qnater/imputegap:0.0.8
Run the Docker container:
docker run -p 8888:8888 qnater/imputegap:0.0.8
Troubleshooting¶
If you face any problems, please open an issue here: https://github.com/eXascaleInfolab/ImputeGAP/issues