Skip to content

qosst/qosst-sim

Repository files navigation

qosst-sim

QOSST Logo

Documentation Status Github - License Github - Release PyPI - Version Code style: black Linting with pylint Checked with mypy Python Version

Docstr coverage


This project is part of QOSST.

Features

qosst-sim allows to perform some simulations.

Installation

The module can be installed with the following command:

pip install qosst-sim

It is also possible to install it directly from the github repository:

pip install git+https://github.com/qosst/qosst-sim

It also possible to clone the repository before and install it with pip or poetry

git clone https://github.com/qosst/qosst-sim
cd qosst-alice
poetry install
pip install .

Documentation

The whole documentation can be found at https://qosst-sim.readthedocs.io/en/latest/

License

As for all submodules of QOSST, qosst-sim is shipped under the Gnu General Public License v3.

Contributing

Contribution are more than welcomed, either by reporting issues or proposing merge requests. Please check the contributing section of the QOSST project fore more information.