tyxonq 0.1.1__tar.gz

tyxonq-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contributing to TyxonQ
+
+For information on how to contribute, see
+[Guide for Contributors](docs/source/contribution.rst).

tyxonq-0.1.1/LICENSE

@@ -0,0 +1,61 @@
+TyxonQ is licensed under the Apache License Version 2.0.
+
+
+Terms of the Apache License Version 2.0:
+--------------------------------------------------------------------
+Apache License 
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/ 
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and 
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and 
+
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and 
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. 
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

tyxonq-0.1.1/MANIFEST.in

@@ -0,0 +1,37 @@
+# Include the license file
+include LICENSE
+
+# Include the readme
+include README.md
+
+# Include important docs
+include CONTRIBUTING.md
+
+# Include examples (用户可能需要这些示例)
+recursive-include examples *.py *.ipynb *.md
+prune examples/.gitignore
+
+# Include tests for people who want to run them
+recursive-include tests *.py
+include tests/conftest.py
+
+# Exclude unnecessary files
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude *.pyd
+global-exclude __pycache__
+global-exclude .git*
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude .pytest_cache
+
+# Exclude development and build artifacts
+exclude .gitignore
+exclude .github
+recursive-exclude .github *
+exclude build
+recursive-exclude build *
+exclude dist
+recursive-exclude dist *
+exclude *.egg-info
+recursive-exclude *.egg-info * 

tyxonq-0.1.1/PKG-INFO

@@ -0,0 +1,312 @@
+Metadata-Version: 2.4
+Name: tyxonq
+Version: 0.1.1
+Summary: Quantum computing framework with multi-backend support
+Author-email: Albert Lee <code@quregenai.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/QureGenAI-Biotech/TyxonQ
+Project-URL: Documentation, https://github.com/QureGenAI-Biotech/TyxonQ
+Project-URL: Repository, https://github.com/QureGenAI-Biotech/TyxonQ
+Project-URL: Issues, https://github.com/QureGenAI-Biotech/TyxonQ/issues
+Project-URL: Official Website, https://www.tyxonq.com
+Keywords: quantum,quantum-computing,quantum-machine-learning,quantum-chemistry,quantum-simulation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cirq>=1.5.0
+Requires-Dist: jax>=0.6.2
+Requires-Dist: numpy>=2.0.2
+Requires-Dist: opt-einsum>=3.4.0
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: qiskit>=2.1.0
+Requires-Dist: requests>=2.32.4
+Requires-Dist: ruff>=0.12.2
+Requires-Dist: scipy>=1.13.1
+Requires-Dist: symengine>=0.14.1
+Requires-Dist: sympy>=1.14.0
+Requires-Dist: tensorflow>=2.19.0
+Requires-Dist: tensornetwork>=0.4.6
+Requires-Dist: torch>=2.7.1
+Provides-Extra: dev
+Requires-Dist: jupyter>=1.1.1; extra == "dev"
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-lazy-fixtures>=1.1.4; extra == "dev"
+Requires-Dist: build>=0.8.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Dynamic: license-file
+
+<h2><p align="center">TyxonQ</p></h2>
+<h3><p align="center">Full-stack Quantum Software Framework on Real Machine</p></h3>
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+[![Real Quantum Hardware](https://img.shields.io/badge/Quantum%20Hardware-Homebrew__S2-brightgreen)](https://www.tyxonq.com/)
+
+TyxonQ​​ 太玄量子 is a full-stack quantum software framework for quantum simulation, optimization, and quantum machine learning. Forked from the open-source project ​[​TensorCircuit](https://github.com/tencent-quantum-lab/tensorcircuit)​​ and licensed under Apache License 2.0, it integrates modern quantum programming paradigms including automatic differentiation, just-in-time compilation, and hardware acceleration. 
+
+**🚀 REAL QUANTUM HARDWARE READY**: TyxonQ supports **real quantum machine execution** through our quantum cloud services powered by **QureGenAI**. Currently featuring the **Homebrew_S2** quantum processor, enabling you to run your quantum algorithms on actual quantum hardware, not just simulators.
+
+***Try Real Quantum Computer Right Now！***: [Getting a Key](https://www.tyxonq.com/) to register and obtain your API key
+
+Innovatively combining generative AI, heterogeneous computing architectures, TyxonQ delivers ​​end-to-end solutions​​ for quantum chemistry, drug discovery, and materials science.
+
+## 🏗️ Quantum-Classical Hybrid Architecture
+
+TyxonQ implements a comprehensive quantum-classical hybrid workflow that bridges high-level quantum algorithms to executable quantum programs:
+
+```mermaid
+graph TB
+    subgraph "Real Problems"
+        A[Quantum Algorithm] --> B[Circuit Structure]
+    end
+    
+    subgraph "Quantum Circuit Design"
+        B --> C[Sampling<br/>Heuristic Algorithm<br/>RL<br/>Machine Learning]
+        C --> D[Unitary Matrix]
+        D --> E[Logic Circuit Synthesis<br/>Logic Circuit Optimization]
+        E --> F[Logic Circuit]
+    end
+    
+    subgraph "Quantum Compilation"
+        F --> G[Gate Count<br/>Circuit Depth<br/>Execution Time<br/>Fidelity]
+        G --> H[Dynamic Programming<br/>Heuristic Algorithm<br/>Reduction<br/>Machine Learning]
+    end
+    
+    subgraph "Hardware Design"
+        H --> I[Qubit Mapping<br/>Qubit Routing]
+        I --> J[Executable Program<br/>Homebrew_S2]
+    end
+    
+    style J fill:#e1f5fe
+    style A fill:#f3e5f5
+```
+
+### Architecture Components:
+- **🧮 Quantum Algorithm Layer**: High-level quantum algorithm specification
+- **🔄 Circuit Structure**: Parameterized quantum circuits with rotation parameters
+- **⚙️ Logic Circuit Synthesis**: Automated circuit optimization and compilation
+- **🎯 Qubit Mapping**: Physical qubit topology-aware mapping and routing
+- **💻 Hardware Execution**: Direct execution on **Homebrew_S2** quantum processor
+
+## Features
+
+### 🔥 Real Quantum Hardware Integration
+- **Production-Ready Quantum Execution**: Direct integration with **QureGenAI's Homebrew_S2** quantum processor
+- **Pulse-Level Control**: Support for both gate-level operations and **pulse-level signals** for advanced quantum control
+- **Real-Time Quantum Computing**: Execute your quantum algorithms on actual quantum hardware with low latency
+- **Quantum-Classical Hybrid Workflows**: Seamlessly combine classical preprocessing with quantum execution
+
+### 🚀 Upcoming API & MCP Services (Coming Soon)
+- **🔗 Quantum API Gateway**: RESTful APIs for direct quantum hardware access
+- **🤖 LLM Integration**: Model Control Protocol (MCP) services for large language model integration
+- **☁️ Quantum Cloud Services**: Scalable quantum computing as a service
+- **📊 Real-time Monitoring**: Quantum job monitoring and result analytics
+
+### Unified Quantum-Classical Hybrid Computing Paradigm​​
+- Supports efficient simulation and optimization of variational quantum algorithms (​​VQE, QAOA​​), featuring a built-in ​​automatic differentiation engine​​ for seamless integration with PyTorch/TensorFlow gradient computation workflows.
+- Provides a ​​hybrid task scheduler​​ that dynamically allocates quantum hardware and classical computing resources (CPU/GPU) for acceleration​​.
+
+### Multi-Level Hardware Support​​
+​​- **Direct Quantum Hardware Integration​​**: Compatible with mainstream quantum processors (e.g., superconducting), supporting low-level control from ​​gate-level operations​​ to **​​pulse-level signals** :fire: :fire: :fire:​.
+- ​​**Heterogeneous Computing Optimization​​**: Enhances simulation throughput via ​​GPU vectorization​​ and quantum instruction compilation.
+
+### Generative AI Integration​​
+- Built-in [Generative ​Quantum Eigensolver (GQE)](https://arxiv.org/abs/2401.09253)​​ and [​​Quantum Machine Learning (QML)](​​https://arxiv.org/abs/2502.01146) modules for direct pre-trained model deployment in tasks like molecular structure generation and protein folding computing.
+- Supports ​​large language model (LLM) interaction​​, enabling automated ​​"natural language → quantum circuit"​​ generation (experimental feature).
+
+### Domain-Specific Toolkits​​
+- **Quantum Chemistry Suite​​**: Includes molecular Hamiltonian builders and electronic structure analysis tools, compatible with classical quantum chemistry and drug discovery framework like [PySCF](https://pyscf.org/), [ByteQC](https://github.com/bytedance/byteqc) and [​​OpenMM](https://openmm.org/)​​.
+- ​​**Materials Simulation Library​​**: Integrates ​​quantum-accelerated density functional theory (DFT)​​ modules for predicting novel material band structures.
+
+## 🚀 Roadmap & Development Status
+
+### ✅ Current Features (v1.x)
+- [x] Quantum circuit simulation and optimization
+- [x] **Real quantum hardware execution** (Homebrew_S2)
+- [x] Automatic differentiation engine
+- [x] Multi-backend support (NumPy, PyTorch, TensorFlow, JAX)
+- [ ] Variational quantum algorithms (VQE,GQE,QAOA)
+- [ ] Quantum chemistry toolkit integration
+
+### 🔄 In Progress (v2.x)
+- [ ] **Quantum API Gateway** - RESTful APIs for quantum hardware access
+- [ ] **MCP Services** - Large language model integration protocols  
+- [ ] Advanced quantum error correction protocols
+- [ ] Enhanced pulse-level control interface
+- [ ] Real-time quantum job monitoring dashboard
+- [ ] Quantum circuit optimization using machine learning
+
+### 🎯 Future Plans (v3.x+)
+- [ ] **Multi-QPU Support** - Support for additional quantum processors
+- [ ] **Quantum Networking** - Distributed quantum computing capabilities
+- [ ] **Advanced QML Models** - Pre-trained quantum machine learning models
+- [ ] **Natural Language Interface** - "English → Quantum Circuit" generation
+- [ ] **Quantum Advantage Benchmarks** - Standardized performance metrics
+- [ ] **Enterprise Cloud Platform** - Scalable quantum computing infrastructure
+
+### 🧪 Experimental Features
+- [ ] Quantum generative adversarial networks (QGANs)
+- [ ] Quantum federated learning protocols
+- [ ] Quantum-enhanced drug discovery pipelines
+- [ ] Materials discovery acceleration frameworks
+
+## Installation
+The package now is written in pure Python and can be obtained via `pip` or 
+
+Install from source:
+
+```bash
+uv build
+uv pip install dist/tyxonq-0.1.1-py3-none-any.whl
+```
+
+`uv` as:
+```bash
+pip install tyxonq
+```
+or
+```bash
+uv pip install tyxonq
+```
+or you can install it from github:
+```bash
+git clone https://github.com/QureGenAI-Biotech/TyxonQ.git
+cd tyxonq
+pip install --editable .
+```
+
+## Get Started Example
+
+See examples/Get_Started_Demo.ipynb
+
+## 🔑 Real Quantum Hardware Setup
+
+### Getting API Access
+1. **Apply for API Key**: Visit [TyxonQ Quantum AI Portal](https://www.tyxonq.com/) to register and obtain your API key
+2. **Hardware Access**: Request access to **Homebrew_S2** quantum processor through API [TyxonQ QPU API](https://www.tyxonq.com)
+
+### Configuration
+Set up your API credentials:
+
+```python
+import tyxonq as tq
+from tyxonq.cloud import apis
+import getpass
+
+# Configure quantum hardware access
+API_KEY = getpass.getpass("Input your TyxonQ API_KEY:")
+apis.set_token(API_KEY) # Get from https://www.tyxonq.com
+```
+
+### Real Hardware Example
+
+See 'examples/simple_demo_1.py' , run:
+```shell
+python examples/simple_demo_1.py
+```
+
+Code:
+
+```python
+import sys
+sys.path.append("./")
+
+import tyxonq as tq
+import getpass
+from tyxonq.cloud import apis
+import time
+# Configure for real quantum hardware
+apis.set_token(getpass.getpass("Input your TyxonQ API_KEY: "))
+
+provider = "tyxonq"
+device = "homebrew_s2"
+
+# Create and execute quantum circuit on real hardware
+def quantum_hello_world():
+    c = tq.Circuit(2)
+    c.H(0)                    # Hadamard gate on qubit 0
+    c.CNOT(0, 1)             # CNOT gate between qubits 0 and 1
+    c.rx(1, theta=0.2)       # Rotation around x-axis
+    
+    # Execute on real quantum hardware
+
+    print("Submit task to TyxonQ")
+
+    task = apis.submit_task(provider = provider,
+                        device = device,
+                        circuit = c,
+                        shots = 100)
+    print(f"Task submitted: {task}")
+    print("Wait 20 seconds to get task details")
+    time.sleep(20)
+    print(f"Real quantum hardware result: {task.details()}")
+
+quantum_hello_world()
+
+```
+
+## Basic Usage and Guide
+Considering that the features and documentation related to ​​TyxonQ characteristics​​ are currently under development, you can refer to the upstream library ​​[Tensorcircuit](https://github.com/tencent-quantum-lab/tensorcircuit)​​ for usage guidance in the interim: [Quick Start](https://github.com/tencent-quantum-lab/tensorcircuit/blob/master/docs/source/quickstart.rst) and [full documentation](https://tensorcircuit.readthedocs.io/). We will promptly update the ​​TyxonQ documentation and tutorials in [English](), [Chinese]() and [Japanese]()​​.
+
+- Circuit manipulation:
+```python
+import tyxonq as tq
+c = tq.Circuit(2)
+c.H(0)
+c.CNOT(0,1)
+c.rx(1, theta=0.2)
+print(c.wavefunction())
+print(c.expectation_ps(z=[0, 1]))
+print(c.sample(allow_state=True, batch=1024, format="count_dict_bin"))
+```
+
+- Runtime behavior customization:
+```python
+tq.set_backend("tensorflow")
+tq.set_dtype("complex128")
+tq.set_contractor("greedy")
+```
+
+- Automatic differentiations with jit:
+```python
+def forward(theta):
+    c = tq.Circuit(2)
+    c.R(0, theta=theta, alpha=0.5, phi=0.8)
+    return tq.backend.real(c.expectation((tq.gates.z(), [0])))
+
+g = tq.backend.grad(forward)
+g = tq.backend.jit(g)
+theta = tq.array_to_tensor(1.0)
+print(g(theta))
+```
+
+## Dependencies
+- Python >= 3.7 (supports Python 3.7, 3.8, 3.9, 3.10, 3.11, 3.12+)
+- PyTorch >= 1.8.0
+
+## 📧 Contact & Support
+
+- **Home**: [www.tyxonq.com](https://www.tyxonq.com)
+- **Technical Support**: [code@quregenai.com](mailto:code@quregenai.com)
+
+- **General Inquiries**: [bd@quregenai.com](mailto:bd@quregenai.com)
+- **Documentation (beta version)**: [docs.tyxonq.com](https://tensorcircuit.readthedocs.io/)
+- **Issue**:[github issue](https://github.com/QureGenAI-Biotech/TyxonQ/issues)
+
+### Development Team
+- **QureGenAI**: Quantum hardware infrastructure and services
+- **TyxonQ Core Team**: Framework development and optimization
+- **Community Contributors**: Open source development and testing
+
+## License
+TyxonQ is open source, released under the Apache License, Version 2.0.