Metadata-Version: 2.1
Name: pytket_qsharp
Version: 0.4
Summary: Extension for pytket, providing simulators from Microsoft QDK
Home-page: https://github.com/CQCL/pytket
Author: Alec Edgington
Author-email: alec.edgington@cambridgequantum.com
License: CQC Non-Commercial Use Software Licence
Description: # pytket-qsharp
        
        [`pytket`](https://cqcl.github.io/pytket) is a Python module for interfacing
        with CQC t|ket>, a set of quantum programming tools.
        
        Microsoft's [QDK](https://docs.microsoft.com/en-us/quantum/install-guide) is a
        language and associated toolkit for quantum programming.
        
        `pytket_qsharp` is an extension to `pytket` that allows `pytket` circuits to be
        executed on simulators and resource estimators from the Microsoft QDK.
        
        ## Getting started
        
        `pytket_qsharp` is available for Python 3.6, 3.7 and 3.8, on Linux and MacOS. To
        install, run:
        
        ```pip install pytket_qsharp```
        
        In order to use `pytket_qsharp` you will first need to install the `dotnet` SDK
        (3.1) and the `iqsharp` tool. On some Linux systems it is also necessary to
        modify your `PATH`:
        
        1. See [this page](https://dotnet.microsoft.com/download/dotnet-core/3.1) for
        instructions on installing the SDK on your operating system.
        
        2. On Linux, ensure that the `dotnet` tools directory is on your path. Typically
        this will be `~/.dotnet/tools`.
        
        3. Run `dotnet tool install -g Microsoft.Quantum.IQSharp`.
        
        4. Run `dotnet iqsharp install --user`.
        
        ## Backends provided in this module
        
        This module provides three
        [backends](https://cqcl.github.io/pytket/build/html/backends.html), all deriving
        from the `pytket` `Backend` class:
        
        * `QsharpSimulatorBackend`, for simulating a general pure-quantum circuit using
        the QDK;
        
        * `QsharpToffoliSimulatorBackend`, for simulating a Toffoli circuit using the
        QDK;
        
        * `QsharpEstimatorBackend`, for estimating various quantum resources of a
        circuit using the QDK. This provides a `get_resources` method, which returns a
        dictionary.
        
        ## LICENCE
        
        Copyright 2020 Cambridge Quantum Computing
        
        Licensed under a Non-Commercial Use Software Licence (the "Licence"); you may
        not use this product except in compliance with the Licence. You may obtain a
        copy of the Licence in the LICENCE file accompanying these documents or view
        them [here](https://cqcl.github.io/pytket/build/html/licence.html).
        
        Unless required by applicable law or agreed to in writing, software distributed
        under the Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
        CONDITIONS OF ANY KIND, either express or implied. See the Licence for the
        specific language governing permissions and limitations under the Licence, but
        note it is strictly for non-commercial use.
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Description-Content-Type: text/markdown
