Metadata-Version: 2.2
Name: qec
Version: 0.2.0
Summary: Python Tools for Quantum Error Correction
Author-email: Joschka Roffe <joschka@roffe.eu>
License: MIT License
        
        Copyright (c) 2023 qec.Codes
        
        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.
        
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ldpc
Requires-Dist: numpy>=1.24.0
Requires-Dist: scipy>=1.9.3
Requires-Dist: requests
Requires-Dist: beautifulsoup4

<h1 align="center">QEC </h1>
<h3 align="center"> Python Tools for Quantum Error Correction </h3>


- Website: https://qec.codes/

# Table of contents
1. [Features](#features)
2. [Installation](#installation)
3. [Getting started](#getting-started)


# Features

Here will go the description of all our fancy features! 

# Installation 

Obtain a local copy of the package by cloning it, then navigate into the created folder: 

```bash
git clone git@github.com:qec-codes/qec.git
cd qec
```

Finally, install the package:

```bash
pip install -e .
```

You are all set! To import the package use:

```python
In  [1]: import qec

In  [2]: qec.__version__
Out [2]: '0.1.0'

```

# Getting started

A few simple examples 

