# Mistkit {▾▴✦◇▮▭■●}
## Abstract:
In the book "[Q is for quantum](https://www.qisforquantum.org/)", Terry Rudolph describes a formalism with white balls <span style="white-space: nowrap;">(|0>)</span> and black balls <span style="white-space: nowrap;">(|1>)</span>, termed [misty state](https://youtu.be/vqave0V5qAA), to teach quantum theory and quantum computing to folks with only a basic knowledge of arithmetic.
This formalism was for teaching adapted by others and further developed by Adrian German, Edwin Barnes, Marcelo Pias, Qiao Xiang, Sophia Economou.
+ https://arxiv.org/abs/2005.07874 # Economou, Rudolph, Barnes 2020
+ https://arxiv.org/abs/2210.02868 # Economou, Barnes 2022
+ https://dl.acm.org/doi/10.1145/3626253.3633435 # German, Pias, Xiang 2024
For quantum computing, International Business Machines developed [Qiskit](https://en.wikipedia.org/wiki/Qiskit), a popular, [Python](https://en.wikipedia.org/wiki/Python_(programming_language)) based, free and open-source software stack.
+ https://docs.quantum.ibm.com/
+ https://github.com/Qiskit/qiskit
+ https://www.ibm.com/quantum/qiskit
All what **Mistkit** does is adding to Qiskit's state\_drawer function the possibility to output Statevectors in *misty state* formalism, alongside the already available Statevectors output formats (*text*, *latex*, *latex\_source*, *qsphere*, *hinton*, *bloch*, *city*, *paulivec*).
## Header:
+ Language: python [>= 3.8](https://devguide.python.org/versions/)
+ Library dependencies: [numpy](https://en.wikipedia.org/wiki/NumPy), qiskit
+ Date: 2024-07
+ License: [Apache 2.0](https://en.wikipedia.org/wiki/Apache_License)
+ Author: Elmar Bucher
+ User manual: this README.md file
+ Source code: [https://github.com/elmbeech/mistkit](https://github.com/elmbeech/mistkit)
+ Inspiration: Dan Adrian German's CSCI A590 quantum computing class at [Indiana University](https://www.iu.edu/index.html).
## HowTo Guide:
1. Install or update to the latest mistkit version:
```bash
pip install -U mistkit
```
1. Load mistkit:
```python
import mistkit
```
1. Run minimal example:
```python
# load libraries
from qiskit import QuantumCircuit
from qiskit.quantum_info import Statevector
import pylatex
import mistkit
# generate 8[qubit] quantum circuit
qc = QuantumCircuit(8)
qc.x([0,1,3,5,6,7]) # state 0b11101011
qc.draw()
# read out the quantum circuit state vector
sv = Statevector.from_instruction(qc)
print(sv.data) # numpy state vector array.
print(sv.draw('mist')) # state vector in Terry Rudolph's misty state notation.
sv.draw('latex') # state vector in Paul Dirac's ket notation.
```
1. Uninstall mistkit:
```bash
pip uninstall mistkit
```
## Refernce Manual:
1. Read the [docstrings](https://en.wikipedia.org/wiki/Docstring):
```python
import mistkit
from qiskit import visualization
help(mistkit.state_to_mist)
help(visualization.state_visualization.state_drawer)
help(mistkit.mystify)
```
## Tutorial:
+ [man/misty_bell_states.ipynb](https://github.com/elmbeech/mistkit/blob/main/man/misty_bell_states.ipynb)
## Discussion:
To be developed.
## About Documentation:
Within the mistkit library, we tried to stick to the documentation policy laid out by Daniele Procida in his "[what nobody tells you about documentation](https://www.youtube.com/watch?v=azf6yzuJt54)" talk at PyCon 2017 in Portland, Oregon.
## Cite:
+ ~
## Road Map:
+ ~
## Release Note:
+ version 0.1.1 ok implementation.
+ version 0.0.0 miskit rises from the ashes.
All we know is falling.
Raw data
{
"_id": null,
"home_page": null,
"name": "mistkit",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": "Elmar Bucher <epbucher@iu.edu>",
"keywords": "ibm, misty state, python3, q is for quantum, qiskit, quantum computing, quantum theory",
"author": null,
"author_email": "Elmar Bucher <epbucher@iu.edu>",
"download_url": "https://files.pythonhosted.org/packages/37/86/14de69e70780734f07a55ad47abc419db160bb750957f68d46c088ca2faa/mistkit-0.1.1.tar.gz",
"platform": null,
"description": "# Mistkit {▾▴✦◇▮▭■●}\n\n\n## Abstract:\n\nIn the book \"[Q is for quantum](https://www.qisforquantum.org/)\", Terry Rudolph describes a formalism with white balls <span style=\"white-space: nowrap;\">(|0>)</span> and black balls <span style=\"white-space: nowrap;\">(|1>)</span>, termed [misty state](https://youtu.be/vqave0V5qAA), to teach quantum theory and quantum computing to folks with only a basic knowledge of arithmetic.\n\nThis formalism was for teaching adapted by others and further developed by Adrian German, Edwin Barnes, Marcelo Pias, Qiao Xiang, Sophia Economou.\n\n+ https://arxiv.org/abs/2005.07874 # Economou, Rudolph, Barnes 2020\n+ https://arxiv.org/abs/2210.02868 # Economou, Barnes 2022\n+ https://dl.acm.org/doi/10.1145/3626253.3633435 # German, Pias, Xiang 2024\n\nFor quantum computing, International Business Machines developed [Qiskit](https://en.wikipedia.org/wiki/Qiskit), a popular, [Python](https://en.wikipedia.org/wiki/Python_(programming_language)) based, free and open-source software stack.\n\n+ https://docs.quantum.ibm.com/\n+ https://github.com/Qiskit/qiskit\n+ https://www.ibm.com/quantum/qiskit\n\nAll what **Mistkit** does is adding to Qiskit's state\\_drawer function the possibility to output Statevectors in *misty state* formalism, alongside the already available Statevectors output formats (*text*, *latex*, *latex\\_source*, *qsphere*, *hinton*, *bloch*, *city*, *paulivec*).\n\n\n## Header:\n+ Language: python [>= 3.8](https://devguide.python.org/versions/)\n+ Library dependencies: [numpy](https://en.wikipedia.org/wiki/NumPy), qiskit\n+ Date: 2024-07\n+ License: [Apache 2.0](https://en.wikipedia.org/wiki/Apache_License)\n+ Author: Elmar Bucher\n+ User manual: this README.md file\n+ Source code: [https://github.com/elmbeech/mistkit](https://github.com/elmbeech/mistkit)\n+ Inspiration: Dan Adrian German's CSCI A590 quantum computing class at [Indiana University](https://www.iu.edu/index.html).\n\n\n## HowTo Guide:\n\n1. Install or update to the latest mistkit version:\n```bash\npip install -U mistkit\n```\n\n1. Load mistkit:\n```python\nimport mistkit\n```\n\n1. Run minimal example:\n```python\n# load libraries\nfrom qiskit import QuantumCircuit\nfrom qiskit.quantum_info import Statevector\nimport pylatex\nimport mistkit\n\n# generate 8[qubit] quantum circuit\nqc = QuantumCircuit(8)\nqc.x([0,1,3,5,6,7]) # state 0b11101011\nqc.draw()\n\n# read out the quantum circuit state vector\nsv = Statevector.from_instruction(qc)\nprint(sv.data) # numpy state vector array.\nprint(sv.draw('mist')) # state vector in Terry Rudolph's misty state notation.\nsv.draw('latex') # state vector in Paul Dirac's ket notation.\n```\n\n1. Uninstall mistkit:\n```bash\npip uninstall mistkit\n```\n\n\n## Refernce Manual:\n\n1. Read the [docstrings](https://en.wikipedia.org/wiki/Docstring):\n```python\nimport mistkit\nfrom qiskit import visualization\n\nhelp(mistkit.state_to_mist)\nhelp(visualization.state_visualization.state_drawer)\nhelp(mistkit.mystify)\n```\n\n\n## Tutorial:\n\n+ [man/misty_bell_states.ipynb](https://github.com/elmbeech/mistkit/blob/main/man/misty_bell_states.ipynb)\n\n\n## Discussion:\n\nTo be developed.\n\n\n## About Documentation:\n\nWithin the mistkit library, we tried to stick to the documentation policy laid out by Daniele Procida in his \"[what nobody tells you about documentation](https://www.youtube.com/watch?v=azf6yzuJt54)\" talk at PyCon 2017 in Portland, Oregon.\n\n\n## Cite:\n+ ~\n\n\n## Road Map:\n+ ~\n\n\n## Release Note:\n\n+ version 0.1.1 ok implementation.\n+ version 0.0.0 miskit rises from the ashes.\n\nAll we know is falling.\n",
"bugtrack_url": null,
"license": null,
"summary": "mistkit extends the python3 based qiskit quantum computing language state_drawer function with a misty state output possibility.",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://github.com/elmbeech/mistkit/blob/main/README.md",
"Hompage": "https://github.com/elmbeech/mistkit",
"Issues": "https://github.com/elmbeech/mistkit/issues",
"Source": "https://github.com/elmbeech/mistkit"
},
"split_keywords": [
"ibm",
" misty state",
" python3",
" q is for quantum",
" qiskit",
" quantum computing",
" quantum theory"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "49c1b631ea70ab3abefa55423ea0857038208c957c958efa285333151ada823e",
"md5": "1391caadcb0e59dd8a14fc63abdba8ba",
"sha256": "7c8c25528f1a20e0570c1594cedcecdfea01a0c9db3d399f5f107f1b322749df"
},
"downloads": -1,
"filename": "mistkit-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1391caadcb0e59dd8a14fc63abdba8ba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 10141,
"upload_time": "2024-07-25T21:30:41",
"upload_time_iso_8601": "2024-07-25T21:30:41.114899Z",
"url": "https://files.pythonhosted.org/packages/49/c1/b631ea70ab3abefa55423ea0857038208c957c958efa285333151ada823e/mistkit-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "378614de69e70780734f07a55ad47abc419db160bb750957f68d46c088ca2faa",
"md5": "c6c6b89ba0fc52a7877f9aaab3424146",
"sha256": "f5dd519ddaafee674bce2d5d03a5e8309078a73e5eb6b2c0be35f5851d0cda6e"
},
"downloads": -1,
"filename": "mistkit-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "c6c6b89ba0fc52a7877f9aaab3424146",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 12627,
"upload_time": "2024-07-25T21:30:42",
"upload_time_iso_8601": "2024-07-25T21:30:42.404069Z",
"url": "https://files.pythonhosted.org/packages/37/86/14de69e70780734f07a55ad47abc419db160bb750957f68d46c088ca2faa/mistkit-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-25 21:30:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "elmbeech",
"github_project": "mistkit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mistkit"
}
JSON
