Metadata-Version: 2.3
Name: skqulacs
Version: 0.5.3
Summary: scikit-qulacs is a library for quantum neural network. This library is based on qulacs and named after scikit-learn.
License: MIT
Author: Qulacs-Osaka
Author-email: qulacs.osaka@gmail.com
Requires-Python: >=3.9
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Dist: numpy (>=1.24.0,<2.0.0)
Requires-Dist: qulacs (>=0.5.0)
Requires-Dist: scikit-learn (>=1.0.0,<2.0.0)
Requires-Dist: scipy (>=1.10.0)
Requires-Dist: typing-extensions (>=4.3.0,<5.0.0)
Project-URL: Documentation, https://qulacs-osaka.github.io/scikit-qulacs/index.html
Project-URL: Homepage, https://github.com/Qulacs-Osaka/scikit-qulacs
Project-URL: Repository, https://github.com/Qulacs-Osaka/scikit-qulacs
Description-Content-Type: text/markdown

# scikit-qulacs

[![Unit test](https://github.com/Qulacs-Osaka/scikit-qulacs/actions/workflows/unittest.yml/badge.svg?branch=main)](https://github.com/Qulacs-Osaka/scikit-qulacs/actions/workflows/unittest.yml)
[![Build and Deploy Documentation](https://github.com/Qulacs-Osaka/scikit-qulacs/actions/workflows/doc.yml/badge.svg?branch=main)](https://github.com/Qulacs-Osaka/scikit-qulacs/actions/workflows/doc.yml)
[![codecov](https://codecov.io/gh/Qulacs-Osaka/scikit-qulacs/branch/main/graph/badge.svg?token=8RCM3B9KQ8)](https://codecov.io/gh/Qulacs-Osaka/scikit-qulacs)
[![PyPI version](https://badge.fury.io/py/skqulacs.svg)](https://badge.fury.io/py/skqulacs)
[![MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)

scikit-qulacs is a library for quantum neural network. This library is based on qulacs and named after scikit-learn.

## Requirements
* pip
* Python >= 3.7

## Installation
### pip
```bash
pip install skqulacs
```

### Build from Source
Install [poetry](https://python-poetry.org/docs/) before building package.
```bash
git clone https://github.com/Qulacs-Osaka/scikit-qulacs.git
cd scikit-qulacs
poetry install
```

## Documentation
Tutorial: [scikit-qulacs チュートリアル](./doc/source/notebooks/0_tutorial.ipynb) (Only Japanese version is available now)

API Documentation and example notebooks: [scikit-qulacs documentation](https://qulacs-osaka.github.io/scikit-qulacs/index.html)

