garymooney / qmuvi

qMuVi - A python package that converts quantum circuits into audiovisual experiences, bridging the gap between complex quantum computations and human perception. Render music videos that reveal the evolution of quantum states during algorithm processing, making quantum computing more intuitive and accessible.
https://garymooney.github.io/qmuvi/
GNU Lesser General Public License v2.1
14 stars 4 forks source link

Prep for pypi gm #25 #27

Closed garymooney closed 1 year ago

garymooney commented 1 year ago

Addressed issue #25 Prepare package for PyPI and setup poetry with tox and autodocs (https://github.com/garymooney/qmuvi/issues/25).

qMuVi has been deployed to PyPI (https://pypi.org/project/qmuvi/).

Docs have been generated and are available on the project's github page (https://garymooney.github.io/qmuvi/).

Poetry is now used to manage the project, see CONTRIBUTING.md for instructions on how to setup the project.

Batch files that build and run docker images have been added for linux testing. tox is used for the step by step instructions in the tests. A test has been added that checks whether timidity works. Github actions have been added that build and deploy docs and run the tox tests. The tests are all passing.

Many other infrastructure changes were made to the project, too many to remember and list here.