# Overview¶

This webpage introduces an open-source index modulation toolkit (IMToolkit). This toolkit attempts to facilitate reproducible research in wireless communications. The major advantages of this toolkit are highlighted as follows:

• It accelerates bit error ratio and average mutual information simulations by relying on a state-of-the-art Nvidia GPU and the massively parallel algorithms proposed in [1].

• It also supports the representative multiplexing schemes for ideal MIMO and OFDM scenarios, in addition to the IM family.

• It contains a comprehensive database of designed active indices, that determine the achievable performance of the generalized spatial modulation or the subcarrier-index modulation.

## Installation Guide¶

IMToolkit is available from the Python official package repository PyPi.

> pip install imtoolkit


This installation requires NumPy, Pandas, SciPy, SymPy, Numba, and tqdm, all of which are popular Python packages. Additionally, it is strongly recommended to install CuPy 5.40+. IMToolkit is heavily dependent on CuPy to achieve significantly fast Monte-Carlo simulations. The key components required by CuPy are listed here. In case CuPy is not installed in your environment, IMToolkit uses NumPy only. Note that the CuPy-based simulation is 145 times faster than the NumPy-based calculation, as reported in [1].

The above PyPi package excluded the designed active indices due to their large file size, which exceeds 500MB. Hence, this reduced-size PyPi package will automatically download a required file from the GitHub repository or a mirror website. If you need all the project files, to use imtoolkit offline, it is recommended to obtain the package from GitHub as follows:

> pip install git+https://github.com/imtoolkit/imtoolkit


The IMToolkit development team welcomes other researchers’ contributions and pull requests. In that case, it would be better to install the latest package and activate the editable mode as follows:

> git clone https://github.com/imtoolkit/imtoolkit
> pip install -e ./imtoolkit # this activates the editable mode


## Citations¶

It would be very appreciated if you cite the following references when using IMToolkit.

Of course, if your project relies on CuPy, the following reference is highly recommended.