1"""
 2# Qiskit-Classroom
 3
 4Qiskit-classroom is a toolkit that helps implement quantum algorithms by converting and visualizing different
 5expressions used in the Qiskit ecosystem using Qiskit-classroom-converter.
 6The following three transformations are supported.
 7
 8* Quantum Circuit to Dirac notation
 9
10* Quantum Circuit to Matrix
11
12* Matrix to Quantum Circuit
13
14## Getting Started
15
16### Prerequisites
17
18* LaTeX distribution(or program) must be installed
19
20  * On GNU/Linux recommend TeX Live
21
22  * On Windows recommend MiKTeX
23
24* git should be installed
25
26* python must be installed (3.9 <= X <= 3.11)
27
28* Qt6(>= 6.0.x) must be installed
29    * macOS : https://pyside.readthedocs.io/en/latest/installing/macosx.html
30
31### Install with Flatpak (GNU/Linux)
32
33We're currently packaging flatpak package. please wait for a couple of days
34
35### Install with PyPi (Windows, macOS)
36
37```
38pip install qiskit-classroom
39```
40
41.. warning:: Apple Silicon
42    ARM Processor not supported read this article
43
44you must install latex distribution(program).
45
46## How to debug
47
48```bash
49# download package
50git https://github.com/KMU-quantum-classrooom/qiksit-classroom.git
51
52# install python packages
53cd qiskit-classroom
54pip install -r requirements.txt
55
56# run scripts
57python -m main.py
58```
59
60## Acknowledgement
61
62* 국문 : "본 연구는 2022년 과학기술정보통신부 및 정보통신기획평가원의 SW중심대학사업의 연구결과로 수행되었음"(2022-0-00964)
63
64* English : "This research was supported by the MIST(Ministry of Science, ICT), Korea, under the National Program for Excellence in SW), supervised by the IITP(Institute of Information & communications Technology Planning & Evaluation) in 2022"(2022-0-00964)
65
66## License
67
68Qiskit-Classroom is licensed under the Apache License, Version 2.0
69"""
70
71#  Licensed to the Apache Software Foundation (ASF) under one
72#  or more contributor license agreements.  See the NOTICE file
73#  distributed with this work for additional information
74#  regarding copyright ownership.  The ASF licenses this file
75#  to you under the Apache License, Version 2.0 (the
76#  "License"); you may not use this file except in compliance
77#  with the License.  You may obtain a copy of the License at
78#
79#    http://www.apache.org/licenses/LICENSE-2.0
80#
81#  Unless required by applicable law or agreed to in writing,
82#  software distributed under the License is distributed on an
83#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
84#  KIND, either express or implied.  See the License for the
85#  specific language governing permissions and limitations
86#  under the License.
87
88from qiskit_class_converter import (
89    __FULL_VERSION__ as qiskit_classroom_converter_version,
90)
91
92QISKIT_CLASSROOM_CONVERTER_VERSION_STR = " ".join(
93    [f"{key}: {value}" for key, value in qiskit_classroom_converter_version.items()]
94)