quantum-simulator 0.1.5__tar.gz

quantum_simulator-0.1.5/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

quantum_simulator-0.1.5/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

quantum_simulator-0.1.5/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: quantum-simulator
+Version: 0.1.5
+Summary: A Python library for simulating quantum computers and quantum algorithms
+Project-URL: Homepage, https://github.com/beefy/quantum-simulator
+Project-URL: Documentation, https://beefy.github.io/quantum-simulator/
+Project-URL: Repository, https://github.com/beefy/quantum-simulator.git
+Project-URL: Issues, https://github.com/beefy/quantum-simulator/issues
+Project-URL: Changelog, https://github.com/beefy/quantum-simulator/blob/main/CHANGELOG.md
+Author-email: Nathaniel Schultz <nate.schultz@outlook.com>
+Maintainer-email: Nathaniel Schultz <nate.schultz@outlook.com>
+License: Unlicense
+License-File: LICENSE
+Keywords: computing,quantum,quantum-algorithms,simulation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: Public Domain
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Requires-Dist: numpy>=1.20.0
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=6.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-autorefs; extra == 'docs'
+Requires-Dist: mkdocs-gen-files; extra == 'docs'
+Requires-Dist: mkdocs-literate-nav; extra == 'docs'
+Requires-Dist: mkdocs-material>=9.4.0; extra == 'docs'
+Requires-Dist: mkdocs-section-index; extra == 'docs'
+Requires-Dist: mkdocs>=1.4.0; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.19.0; extra == 'docs'
+Requires-Dist: pymdown-extensions>=9.0.0; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest>=6.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Quantum Simulator
+
+[![Tests](https://github.com/beefy/quantum-simulator/actions/workflows/tests.yml/badge.svg)](https://github.com/beefy/quantum-simulator/actions/workflows/tests.yml)
+[![PyPI version](https://badge.fury.io/py/quantum-simulator.svg)](https://badge.fury.io/py/quantum-simulator)
+[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue)](https://beefy.github.io/quantum-simulator/)
+[![Python versions](https://img.shields.io/pypi/pyversions/quantum-simulator)](https://pypi.org/project/quantum-simulator/)
+[![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](http://unlicense.org/)
+
+A Python library for simulating quantum computers and quantum algorithms. This package provides an easy-to-use interface for quantum state simulation, gate operations, and circuit execution.
+
+## Features
+
+- 🔬 **Quantum State Simulation**: Accurate simulation of quantum states using state vectors
+- 🚪 **Quantum Gates**: Implementation of common single and multi-qubit gates (X, Y, Z, H, CNOT)
+- 🔗 **Quantum Circuits**: Build and execute complex quantum circuits
+- 📊 **Measurement**: Simulate quantum measurements with proper state collapse
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install quantum-simulator
+```
+
+### Basic Example
+
+```python
+from quantum_simulator import QuantumSimulator, QuantumCircuit
+from quantum_simulator.gates import H_GATE, CNOT_GATE
+
+# Create a 2-qubit quantum simulator
+sim = QuantumSimulator(2)
+
+# Build a Bell state circuit
+circuit = QuantumCircuit(2)
+circuit.add_gate(H_GATE, [0])        # Hadamard on qubit 0
+circuit.add_gate(CNOT_GATE, [0, 1])  # CNOT with control=0, target=1
+
+# Execute the circuit
+circuit.execute(sim)
+
+# Measure the qubits
+result0 = sim.measure(0)
+result1 = sim.measure(1)
+print(f"Measurement: {result0}, {result1}")
+```
+
+## Documentation
+
+Full documentation is available at **[beefy.github.io/quantum-simulator](https://beefy.github.io/quantum-simulator/)**
+
+- [Installation Guide](https://beefy.github.io/quantum-simulator/getting-started/installation/)
+- [Quick Start](https://beefy.github.io/quantum-simulator/getting-started/quickstart/)
+
+## Development
+
+### Setting Up Development Environment
+
+1. **Clone the repository**:
+   ```bash
+   git clone https://github.com/beefy/quantum-simulator.git
+   cd quantum-simulator
+   ```
+
+2. **Install in development mode**:
+   ```bash
+   pip install -e .[dev,docs]
+   ```
+
+3. **Run tests**:
+   ```bash
+   pytest --cov=quantum_simulator --cov-report=xml --cov-report=term
+   ```
+
+4. **Run lint checks**:
+   ```bash
+   flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+   mypy src/
+   ```
+
+4. **Build documentation**:
+   ```bash
+   mkdocs serve
+   ```

quantum_simulator-0.1.5/README.md

@@ -0,0 +1,85 @@
+# Quantum Simulator
+
+[![Tests](https://github.com/beefy/quantum-simulator/actions/workflows/tests.yml/badge.svg)](https://github.com/beefy/quantum-simulator/actions/workflows/tests.yml)
+[![PyPI version](https://badge.fury.io/py/quantum-simulator.svg)](https://badge.fury.io/py/quantum-simulator)
+[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue)](https://beefy.github.io/quantum-simulator/)
+[![Python versions](https://img.shields.io/pypi/pyversions/quantum-simulator)](https://pypi.org/project/quantum-simulator/)
+[![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](http://unlicense.org/)
+
+A Python library for simulating quantum computers and quantum algorithms. This package provides an easy-to-use interface for quantum state simulation, gate operations, and circuit execution.
+
+## Features
+
+- 🔬 **Quantum State Simulation**: Accurate simulation of quantum states using state vectors
+- 🚪 **Quantum Gates**: Implementation of common single and multi-qubit gates (X, Y, Z, H, CNOT)
+- 🔗 **Quantum Circuits**: Build and execute complex quantum circuits
+- 📊 **Measurement**: Simulate quantum measurements with proper state collapse
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install quantum-simulator
+```
+
+### Basic Example
+
+```python
+from quantum_simulator import QuantumSimulator, QuantumCircuit
+from quantum_simulator.gates import H_GATE, CNOT_GATE
+
+# Create a 2-qubit quantum simulator
+sim = QuantumSimulator(2)
+
+# Build a Bell state circuit
+circuit = QuantumCircuit(2)
+circuit.add_gate(H_GATE, [0])        # Hadamard on qubit 0
+circuit.add_gate(CNOT_GATE, [0, 1])  # CNOT with control=0, target=1
+
+# Execute the circuit
+circuit.execute(sim)
+
+# Measure the qubits
+result0 = sim.measure(0)
+result1 = sim.measure(1)
+print(f"Measurement: {result0}, {result1}")
+```
+
+## Documentation
+
+Full documentation is available at **[beefy.github.io/quantum-simulator](https://beefy.github.io/quantum-simulator/)**
+
+- [Installation Guide](https://beefy.github.io/quantum-simulator/getting-started/installation/)
+- [Quick Start](https://beefy.github.io/quantum-simulator/getting-started/quickstart/)
+
+## Development
+
+### Setting Up Development Environment
+
+1. **Clone the repository**:
+   ```bash
+   git clone https://github.com/beefy/quantum-simulator.git
+   cd quantum-simulator
+   ```
+
+2. **Install in development mode**:
+   ```bash
+   pip install -e .[dev,docs]
+   ```
+
+3. **Run tests**:
+   ```bash
+   pytest --cov=quantum_simulator --cov-report=xml --cov-report=term
+   ```
+
+4. **Run lint checks**:
+   ```bash
+   flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+   mypy src/
+   ```
+
+4. **Build documentation**:
+   ```bash
+   mkdocs serve
+   ```

quantum_simulator-0.1.5/docs/development/changelog.md

@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.5] - 2026-01-01
+
+### Added
+- Documentation fixes
+
+## [0.1.4] - 2025-12-16
+
+### Added
+- Fix broken links in documentation
+- Added initial math overview documentation
+
+## [0.1.3] - 2025-12-16
+
+### Added
+- Fix documentation references
+
+## [0.1.2] - 2025-12-16
+
+### Added
+- Fix documentation
+- Fix docs github action
+
+## [0.1.1] - 2025-12-16
+
+### Added
+- Fix dimension mismatch bug
+- Fix CNOT bug
+- Fix documentation
+- Add CONTRIBUTING.md
+- Fix tests
+- Fix linting
+
+## [0.1.0] - 2025-12-16
+
+### Added
+- Initial release
+- Initial project structure
+- Basic quantum simulation functionality
+- Documentation with MkDocs
+- CI/CD with GitHub Actions
+- `QuantumSimulator` class for quantum state simulation
+- Basic quantum gates (X, Y, Z, H, CNOT)
+- `QuantumCircuit` class for building quantum circuits
+- Quantum measurement functionality
+- Comprehensive documentation
+- Unit tests and type checking
+- PyPI packaging configuration
+- GitHub Actions for automated testing and publishing
+
+### Features
+- Support for multi-qubit quantum systems
+- State vector representation of quantum states
+- Gate application and circuit execution
+- Measurement with state collapse
+- Modern Python packaging with `pyproject.toml`
+- MkDocs documentation with Material theme
+- Automated PyPI publishing on releases
+- Automated documentation deployment to GitHub Pages

quantum_simulator-0.1.5/docs/development/contributing.md

@@ -0,0 +1,37 @@
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](https://beefy.github.io/quantum-simulator/development/contributing/) for details.
+
+### Development Workflow
+
+1. **Fork** the repository
+2. **Create a feature branch**: `git checkout -b feature-name`
+3. **Make changes** and add tests
+4. **Run tests**: `pytest`
+5. **Submit a pull request**
+
+### Code Quality
+
+We use several tools to maintain code quality:
+
+- **pytest**: Testing framework
+- **black**: Code formatting
+- **flake8**: Linting
+- **mypy**: Type checking
+- **pre-commit**: Git hooks
+
+## Requirements
+
+- **Python**: 3.8 or higher
+- **NumPy**: 1.20.0 or higher
+
+## License
+
+This project is licensed under the Unlicense - see the [LICENSE](LICENSE) file for details.
+
+## Links
+
+- **PyPI Package**: [pypi.org/project/quantum-simulator](https://pypi.org/project/quantum-simulator/)
+- **Documentation**: [beefy.github.io/quantum-simulator](https://beefy.github.io/quantum-simulator/)
+- **Source Code**: [github.com/beefy/quantum-simulator](https://github.com/beefy/quantum-simulator)
+- **Issue Tracker**: [github.com/beefy/quantum-simulator/issues](https://github.com/beefy/quantum-simulator/issues)