Metadata-Version: 2.4
Name: qphase
Version: 1.0.0
Summary: Modular Quantum Phase-Space Simulation Framework (Core & CLI)
Author-email: Yu Xue-Hao <yuxuehao23@mails.ucas.ac.cn>
License: MIT License
        
        Copyright (c) 2025 Yu Xue-Hao
        
        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: Homepage, https://github.com/PolarisMegrez/qphase
Project-URL: Repository, https://github.com/PolarisMegrez/qphase
Project-URL: Issues, https://github.com/PolarisMegrez/qphase/issues
Keywords: quantum optics,SDE,simulation,CLI,Typer
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.9
Requires-Dist: rich>=13.0
Requires-Dist: ruamel.yaml>=0.17
Requires-Dist: PyYAML>=6.0
Requires-Dist: pydantic>=2.0
Provides-Extra: numba
Requires-Dist: numba>=0.57; extra == "numba"
Provides-Extra: cupy
Requires-Dist: cupy-cuda12x>=12.0; extra == "cupy"
Provides-Extra: torch
Requires-Dist: torch>=2.0; extra == "torch"
Provides-Extra: standard
Requires-Dist: numba>=0.57; extra == "standard"
Requires-Dist: torch>=2.0; extra == "standard"
Dynamic: license-file

# qphase — A Modular Toolkit for Phase-Space Simulation in Quantum Optics

`qphase` is a small command-line tool for configuring and running phase-space simulations in quantum optics. It serves as the main entry point for the project, handling configuration loading and job execution.

## Features

- **CLI Interface (`qps`)**: A simple command-line interface to run simulations and analysis tasks.
- **Plugin Support**: Loads external packages (like `qphase-sde` and `qphase-viz`) to extend functionality.
- **Session Management**: Basic job tracking with support for resuming interrupted runs and dry-run validation.
- **Configuration**: Uses YAML/JSON files to define simulation parameters and workflows.
- **Parameter Scanning**: Supports simple parameter sweeps (Cartesian and Zipped).

## Installation

```bash
pip install qphase
# Optional: Install standard backends (Numba, PyTorch)
pip install qphase[standard]
```

## Quick Start

1.  **Initialize a project**:
    ```bash
    qps init
    ```

2.  **Run a simulation**:
    ```bash
    qps run my_simulation
    ```

3.  **List available jobs**:
    ```bash
    qps run --list
    ```

## Project Structure

This repository contains the following packages:
- **`qphase`**: The main CLI and scheduler.
- **`qphase-sde`**: The numerical solver for SDEs.
- **`qphase-viz`**: Plotting utilities for simulation data.

## License

MIT License
