Skip to content

Installation Guide

Thank you for choosing QPX. This guide will walk you through the installation process to get QPX Tabular up and running on your machine.

Prerequisites

QPX requires Python 3.8 or higher. Before installing, ensure you have Python installed by running:

python --version

Core Dependencies

QPX heavily relies on the following core libraries for its data manipulation and calculation capabilities: - pandas - numpy

(Note: These will be installed automatically when you install QPX via pip.)

Installation Methods

If QPX is published to PyPI or you have a compiled wheel, you can install it directly using pip:

pip install qpx-tabular

2. Install from Source (Development)

If you want to try the latest development version, or if you plan to contribute to the QPX project, you can install it from source.

  1. Clone the repository: 

    git clone https://github.com/punit-kashyap/qpx.git
cd qpx

  2. Install the package in editable mode: Installing in editable mode (-e) means that any changes you make to the source code will immediately take effect without needing to reinstall the package. 

    pip install -e .

Verifying the Installation

To verify that QPX was installed successfully, open a Python interactive shell or a Jupyter Notebook and try importing it:

import pandas as pd
from qpx import Tabular

# Create a simple test dataframe
df = pd.DataFrame({"Test_Col": [1, 2, 3]})

# Initialize the Tabular class
tab = Tabular(df)

print("QPX Tabular loaded successfully!")

If the code runs without any ModuleNotFoundError, you are ready to go!

Next Steps

Now that you have QPX installed, head over to the Index to learn about the core philosophy of QPX and explore its powerful automated preprocessing features.