Metadata-Version: 2.1
Name: QIRT
Version: 1.2.3
Summary: A quantum information research toolkit
Author-email: "HSIEH, LI-YU" <lyhsieh.lou@gmail.com>
License: MIT License
        
        Copyright (c) 2024 HSIEH, LI-YU
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://slope86.github.io/QIRT
Project-URL: API Reference, https://slope86.github.io/QIRT/reference/
Project-URL: Repository, https://github.com/Slope86/QIRT
Project-URL: Issues, https://github.com/Slope86/QIRT/issues
Classifier: Environment :: Web Environment
Classifier: Environment :: Other Environment
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Framework :: Jupyter
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: qiskit[visualization]>=1.1.0
Requires-Dist: IPython>=8.24.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: mkdocs; extra == "dev"
Requires-Dist: mkdocstrings[python]; extra == "dev"
Requires-Dist: mkdocs-material; extra == "dev"

# QIRT - Quantum Information Research Toolkit

A quantum information research toolkit based on Qiskit, designed to facilitate research and development in quantum information science.

## Quick Start

1. Install QIRT using pip:

    ```bash
    pip install QIRT
    ```

2. Set up Jupyter Notebook (if not already installed):

    ```bash
    pip install jupyter
    jupyter notebook
    ```

## Basic Usage in Jupyter Notebook

Create a new notebook and run the following:

```python
from QIRT import QuantumState, QuantumCircuit

# Create a quantum state
state = QuantumState.from_label('00')

# Visualize the state
state.draw()

# Create a quantum circuit
circuit = QuantumCircuit(2)
circuit.h(0)  # Apply Hadamard gate to the first qubit
circuit.cx(0, 1)  # Apply CNOT gate

# Apply circuit to state
final_state = state.apply(circuit)
final_state.draw()
```

## Documentation

For detailed documentation, tutorials, and how-to guides, visit our [documentation website](https://slope86.github.io/QIRT/).

- [Tutorials](https://slope86.github.io/QIRT/tutorials): Learn the basics of QIRT with hands-on examples.
- [How-To Guides](https://slope86.github.io/QIRT/how_to_guides): Detailed instructions for specific tasks.
- [API Reference](https://slope86.github.io/QIRT/reference): Detailed descriptions of QIRT functions, classes, and modules.

## Requirements

- Python >= 3.10
- qiskit[visualization] >= 1.1.0
- IPython >= 8.24.0
- Jupyter Notebook (for visualization)

## Configuration

QIRT can be configured using `~/.QIRT/config.ini`. See the [documentation](https://slope86.github.io/QIRT/how_to_guides/customize_ket_notation/) for more details.

## License

This project is open source under the MIT license. Note that separately installed extensions are not part of the QIRT project and have their own licenses.

## Support

If you encounter any issues or have questions, please [open an issue](https://github.com/slope86/QIRT/issues) on our GitHub repository.
