feihoo87 / qulab

A framework for researchers

QuLab

Documentation can be found at qulab.readthedocs.org.

Installation

We encourage installing QuLab via the pip tool (a python package manager):

python -m pip install QuLab

To install from the latest source, you need to clone the GitHub repository on your machine.

git clone https://github.com/feihoo87/QuLab.git

Then dependencies and QuLab can be installed in this way:

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 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.

License

MIT