Skip to content
 
 

Repository files navigation

qupyt logo

QuPyt - The Quantum Sensing Framework

Documentation | Group Homepage


Welcome to QuPyt! We love Quantum Sensing and Python.

The project you are currently visiting is still under heavy development, and we have not yet settled on a license. We kindly ask you to not use or copy QuPyt without consulting with us first! We plan to change this in the coming months and provide QuPyt under a standard license.

Starting with version 1.0 we will adhere to semantic versioning.

If you want to start contributing of using QuPyt for your own research of application, feel free to reach out!

Please expect breaking changes to the API in the coming months. We plan to make the API stable until April 2024.

Installation

We recommended you use python3.11 or below.

Install a release

To install a release of QuPyt, go to the Releases tab on the right, select a build suitable for your distro (currently only Debian based Linux distros are supported) and install using pip and the link assoziated witht the resource. You can find the command for the latest release below.

python3 -m pip install https://github.com/KarDB/QuPyt/releases/download/v0.1.0/qupyt-0.1.0-py3-none-any.whl

There is no extensive testing performed on the releases.

Install from source

  1. Clone the GitHub repo.

$ git clone https://github.com/KarDB/QuPyt.git
$ cd QuPyt
  1. Build and install QuPyt.

If you don't have build installed, install it with:


$ python3 -m pip install build

Now build and install


$ python3 -m build $ python3 -m pip install dost/.whl 

Documentation

The code documentation can be found here

Funding

We are located at the Technical University of Munich and are funded by the German Research Foundation as well as the European Research Council.

Imprint

Karl Briegel

karl.briegel@tum.de

Lichtenberg Strasse 4

85748 Garching b. München

Germany

About

A python suite for general purpose measurements with a focus on quantum sensing.

Resources

Code of conduct

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages