Metadata-Version: 2.4
Name: quanestimation
Version: 0.2.5
Summary: A package for quantum parameter estimation.
Home-page: https://github.com/QuanEstimation/QuanEstimation
Author: Jing Liu, Huai-Ming Yu
Author-email: liujing@hainanu.edu.cn, huaimingyuuu@gmail.com
License: BSD 3-Clause License
Keywords: quanestimation
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pip>=19.2.3
Requires-Dist: bump2version>=0.5.11
Requires-Dist: wheel>=0.33.6
Requires-Dist: coverage>=4.5.4
Requires-Dist: numpy
Requires-Dist: sympy
Requires-Dist: scipy
Requires-Dist: cvxpy
Requires-Dist: juliacall
Requires-Dist: more_itertools
Requires-Dist: julia_project
Requires-Dist: h5py
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# QuanEstimation

![GitHub release (latest by date)](https://img.shields.io/github/v/release/QuanEstimation/QuanEstimation)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://quanestimation.github.io/QuanEstimation/) 
[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![Downloads](https://static.pepy.tech/badge/quanestimation)](https://pepy.tech/project/quanestimation)


QuanEstimation is a Python-Julia-based open-source toolkit for quantum parameter estimation, which can be used to perform 
general evaluations of many metrological tools and scheme designs in quantum parameter estimation. 


## Documentation
The documentation of QuanEstimation can be found [here](https://quanestimation.github.io/QuanEstimation/).

## Installation
![PyPI](https://img.shields.io/pypi/v/QuanEstimation)

Run the command in the terminal to install QuanEstimation:  

~~~
pip install quanestimation
~~~

## Citation
* If you use QuanEstimation in your research, please cite the following papers:

  [1] M. Zhang, H.-M. Yu, H. Yuan, X. Wang, R. Demkowicz-Dobrzański, and J. Liu, 
  QuanEstimation: An open-source toolkit for quantum parameter estimation, 
  [Phys. Rev. Res. **4**, 043057 (2022).](https://doi.org/10.1103/PhysRevResearch.4.043057)

  [2] H.-M. Yu and J. Liu, QuanEstimation.jl: An open-source Julia framework for quantum parameter estimation, 
  [arXiv: 2405.12066.](https://doi.org/10.48550/arXiv.2405.12066)

* Development of the GRAPE algorithm in quantum parameter estimation can be found in the following papers:

  * **auto-GRAPE**:

    M. Zhang, H.-M. Yu, H. Yuan, X. Wang, R. Demkowicz-Dobrzański, and J. Liu, 
    QuanEstimation: An open-source toolkit for quantum parameter estimation, 
    [Phys. Rev. Res. **4**, 043057 (2022).](https://doi.org/10.1103/PhysRevResearch.4.043057)

  * **GRAPE for single-parameter estimation**:

    J. Liu and H. Yuan, Quantum parameter estimation with optimal control, 
    [Phys. Rev. A **96**, 012117 (2017).](https://doi.org/10.1103/PhysRevA.96.012117)

  * **GRAPE for multiparameter estimation**:

    J. Liu and H. Yuan, Control-enhanced multiparameter quantum estimation, 
    [Phys. Rev. A **96**, 042114 (2017).](https://doi.org/10.1103/PhysRevA.96.042114)


=======
History
=======

0.1.0 (2022-06-04)

0.1.3 (2022-06-08)

0.1.4 (2022-06-19)

0.1.5 (2022-07-07)

0.2.0 (2022-09-01)

0.2.1 (2024-02-08)

0.2.2 (2024-03-19)

0.2.3 (2024-03-21)

0.2.4 (2024-05-11)

0.2.5 (2024-10-16)

------------------

* First release on PyPI.
