The files in this repository can be downloaded/cloned using the command

git clone https://github.com/indian-institute-of-science-qc/qiskit-aakash

We advise you to use a virtual environment to install the files. Virtual environment can be created using conda.

conda create -n name_of_the_env python=3

See this to install conda into your system.

You can activate/deactivate the virtual enviroment.

conda activate name_of_the_env
conda deactivate

Once you have activated your virtual environment go to the folder where you have kept the cloned files.
To install the folder type in the terminal

pip install -e .

The code for the new backend dm_simulator can be found in dm_simulator.py. This backend also uses some functionalities from basicaertools.py.

Once installed, files can be changed and run in python. For example,

python3

>>> from qiskit import QuantumCircuit,BasicAer,execute
>>> qc = QuantumCircuit(2)
>>> # Gates
>>> qc.x(1)
>>> qc.cx(0,1)
>>> # execution
>>> backend = BasicAer.get_backend('dm_simulator')
>>> run = execute(qc,backend)
>>> result = run.result()
>>> print(result['results'][0]['data']['densitymatrix'])

It would output the resultant densitymatrix as,

[[0 0 0 0]
[0 1 0 0]
[0 0 0 0]
[0 0 0 0]]

There are some jupyter notebooks in the repository which provide detailed examples about how to use this simulator. Those can be viewed in Github. But the easiest way to interact with them is by using Binder Image.