Installation

Requirements

  • Python 3.9+

  • JAX

  • NumPy

  • Pandas

Installation

It is strongly recommended to install quantammsim in a virtual environment to avoid conflicts with other packages. You can use either venv (standard Python) or conda.

Using venv

For Windows:

python -m venv venv
.\venv\Scripts\activate

For macOS/Linux:

python -m venv venv
source venv/bin/activate

Using Conda

Alternatively, you can use Conda to create an environment. We recommend using Python 3.10:

conda create -n qsim python=3.10
conda activate qsim

Installing the Package

Once your virtual environment is activated, install the package:

git clone https://github.com/QuantAMMProtocol/quantammsim.git
cd quantammsim
pip install -e .

To deactivate the virtual environment when you’re done:

deactivate

Or if you are using Conda:

conda deactivate

Data Files

The package can download data files for simulation and testing. To download these files, navigate to the scripts directory first:

cd scripts
python download_data.py <tickers>

For example:

cd scripts
python download_data.py BTC ETH USDC

Note

The script will automatically:

  • Download required files

  • Verify file integrity

  • Extract contents to the appropriate location

  • Show download and extraction progress