mentpy 0.1.0a12

A Python library for simulating MBQC circuits

The mentpy library is an open-source software for simulations of measurement-based quantum computing circuits. Currently, this package is in its alpha version and many features are still in development.

Installation

You can install the stable release of mentpy from PyPI using:

pip install mentpy

For the latest, potentially unstable version, you can install directly from the source:

pip install git+https://github.com/mentpy/mentpy.git

If you're contributing to mentpy and need to install development dependencies, you can do so using:

git clone https://github.com/mentpy/mentpy.git
cd mentpy
pip install -e '.[dev]'

This command installs mentpy in editable mode with its additional development dependencies.

Usage

To simulate a measurement pattern, you can use the mp.PatternSimulator.

import mentpy as mp

st = mp.templates.grid_cluster(2,4)
ps = mp.PatternSimulator(st)
output = ps(np.random.rand(len(st.outputc)))

For visualization of circuits, you can use the mp.draw(st) function

To calculate the lie algebra of a model $G_\theta$, you can use the mp.utils.calculate_lie_algebra function

lie_alg = mp.utils.calculate_lie_algebra(st)
len(lie_alg)
>> 16

Documentation

The documentation for mentpy can be found here.

Contributing

We welcome contributions to mentpy! Please see our contributing guidelines for more information.

How to cite

If you use mentpy in your research, please cite it as follows:

@software{Mantilla_Mentpy_2023,
    title = {{MentPy: A python package for simulating and training QML models in the MBQC framework.}},
    author = {Mantilla Calderón, Luis},
    year = {2023},
    url = {https://github.com/mentpy/mentpy},
}