Skip to content

Latest commit

 

History

History
137 lines (116 loc) · 5.17 KB

README.md

File metadata and controls

137 lines (116 loc) · 5.17 KB

Quantum-robot Python Package



quantum-robot is a Python package for quantum-like perception modeling for robotics. The package exploits Qiksit framework, implementing the models on quantum circuits which can be simulated on a classical computer or sent to a quantum backend (service provided by IBM Quantum Experience).

Documentation Website Repository
Link 🔗 Link 🔗 Link 🔗

The project was started in 2019 by Davide Lanza as a Master thesis research, with the help of Fulvio Mastrogiovanni and Paolo Solinas. It is currently maintained by Davide Lanza.

Getting Started

Check the Getting Started section of the Documentation for the Installation Guide.

Demo Notebooks and Documentation is made available as well

Development

To install the package and run tests directly from the repository, poetry is suggested:

git clone https://github.com/Davidelanz/quantum-robot.git
poetry install
poetry run pytest .

To correctly run all the tests, one needs a redis server on port 6379:

docker run --name redis_contaner -p 6379:6379 -d redis

To open an interactive session using the provided notebooks in the docs/notebooks directory, one can use poetry as well:

poetry run jupyter-notebook

Contributing

If you are interested in the project, we welcome new contributors of all experience levels. For any questions, contact the maintainer.

An example module with the docstring standard we adopted is available here.

Citing

If you use quantum-robot in a scientific publication, we would appreciate citations to the following paper:

@InProceedings{10.1007/978-3-030-71151-1_44,
    author="Lanza, Davide
        and Solinas, Paolo
        and Mastrogiovanni, Fulvio",
    editor="Siciliano, Bruno
        and Laschi, Cecilia
        and Khatib, Oussama",
    title="Multi-sensory Integration in a Quantum-Like Robot Perception Model",
    booktitle="Experimental Robotics",
    year="2021",
    publisher="Springer International Publishing",
    address="Cham",
    pages="502--509",
    isbn="978-3-030-71151-1"
}

License

GNU-GPLv3