# QuLab
[![View build status](https://travis-ci.org/feihoo87/QuLab.svg?branch=master)](https://travis-ci.org/feihoo87/QuLab)
[![Coverage Status](https://coveralls.io/repos/github/feihoo87/QuLab/badge.svg)](https://coveralls.io/github/feihoo87/QuLab)
[![Updates](https://pyup.io/repos/github/feihoo87/QuLab/shield.svg)](https://pyup.io/repos/github/feihoo87/QuLab/)
[![Docs Status](https://readthedocs.org/projects/qulab/badge/?version=latest)](http://qulab.readthedocs.org)
[![PyPI version](https://badge.fury.io/py/QuLab.svg)](https://badge.fury.io/py/QuLab)
[![](https://img.shields.io/badge/python-3.6%2C%203.7-brightgreen.svg)]()
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3352232.svg)](https://doi.org/10.5281/zenodo.3352232)

**Documentation can be found at [qulab.readthedocs.org](https://qulab.readthedocs.org/).**

## Installation
We encourage installing QuLab via the pip tool (a python package manager):
```bash
python -m pip install QuLab
```

To install from the latest source, you need to clone the GitHub repository on your machine.
```bash
git clone https://github.com/feihoo87/QuLab.git
```

Then dependencies and QuLab can be installed in this way:
```bash
cd QuLab
python -m pip install -e .
```

## Usage


## Running Tests
To run tests:

```
python -m pip install -r requirements-dev.txt
python -m pytest
```

## Attribution
If you make use of this code, please consider citing the Zenodo DOI [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3352232.svg)](https://doi.org/10.5281/zenodo.3352232) as a software citation:
```
@misc{xu_huikai_2019_3352232,
  author       = {Xu, Huikai},
  title        = {QuLab},
  month        = aug,
  year         = 2019,
  doi          = {10.5281/zenodo.3352232},
  url          = {https://doi.org/10.5281/zenodo.3352232}
}
```

## Reporting Issues
Please report all issues [on github](https://github.com/feihoo87/QuLab/issues).

## License

[MIT](https://opensource.org/licenses/MIT)
