QFUNK

Quantum information methods that everybody needs.
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

This package is intended as a central repository for python code pertaining to quantum information science, primarily the subfield of open quantum system dynamics.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

As of the current version, qfunk has only basic dependencies on numpy and scipy. The most recent of these can be downloaded like so

conda install numpy, scipy

Installation

1. Clone the repo

   git clone https://github.com/simonsupercool/qfunk.git

2. CD into directory and install package via local pip command

   pip install qfunk

3. Run the test suite

   python test.py

If all tests pass then the installation was a success, otherwise please raise an issue that includes the failed test output.

Usage

As a general package for quantum information, most standard linear algebra operations are available in qfunk that pertain to this field. On top of this more specific functionality is available, primarily dealing with quantum optics and open quantum systems. Specific examples of which may be found in the examples folder.

For more examples, please refer to the Documentation

Contributing

This package is intended as a broad repository for quantum information related code. As such any contribution that meets this criteria are welcome. If you wish to contribute:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/HowCouldYouHaveNotDoneThisAlready)
3. Commit your Changes (git commit -m 'Add some HowCouldYouHaveNotDoneThisAlready')
4. Push to the Branch (git push origin feature/HowCouldYouHaveNotDoneThisAlready)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.