Installation

Quanturf is compatible with the following operating systems:

  • Windows

  • macOS

  • Linux

  • Cloud environments

Installation Methods

There are two recommended methods to install and use Quanturf: using a virtual environment (venv) or using Docker for containerized installation.

Method 1: Virtual Environment (venv)

Step 1: Create a Virtual Environment This command will create a new directory named "venv" containing the isolated Python environment.

python3 -m venv venv

Step 2: Activate the Virtual Environment Activate the virtual environment by running the appropriate command for your operating system. This will download and install the Quanturf package and its dependencies into the virtual environment.

# For Linux and MacOS
source venv/bin/activate

Step 3: Install Quanturf Once the virtual environment is activated, use pip to install Quanturf

pip install quanturf

Step 4: Run jupyterlab on quanturf

Once quanturf package is installed run following command to open jupyterlab

python -m quanturf jupyterlab

Step 5: Launch Quanturf After installing Quanturf, open a browser and navigate to https://localhost:9000/lab to access the Quanturf JupyterLab interface.

Method 2: Docker (Containerized Installation)

Prerequisite: Install Docker

Before proceeding with the Docker installation, ensure that Docker is installed on your system. Refer to the official Docker documentation for instructions on installing Docker for your specific operating system.

Step 1: Obtain the Docker Compose File Download the Docker Compose file for Quanturf by executing the following command

curl 'https://raw.githubusercontent.com/Quanturf/AlphaLab-Backtesting/main/docker-compose.yaml' -o docker-compose.yaml

Step 2: Start Quanturf using Docker Compose To start Quanturf using Docker Compose, run the following command. This command will fetch the Docker Compose file and save it as "docker-compose.yml" in your current directory.

docker-compose up -d

Step 3: Launch Quanturf After installing Quanturf, open a browser and navigate to http://localhost:9000/lab access the Quanturf JupyterLab interface.

http://localhost:9000/lab

For more details regarding installation, please refer to the accompanying video

Last updated