qudi-core

The qudi-core repository represents the base installation for the qudi Python package.

It provides a versatile framework for modular multi-instrument and multi-computer measurement applications. It enables scientists and engineers to easily develop specialized multithreaded graphical or non-graphical applications.

Most of the more technical details about a complex measurement suite are handled automatically by qudi so the developer can focus on what matters most... the measurement control logic and the optional graphical user interface.

An incomplete list of functionality qudi provides:

• logging
• thread management
• automatic app status dumping/loading
• runtime resource management
• base modules for hardware interfaces, measurement logics and graphical user interfaces
• inter-module communication
• support for installable qudi namespace package addons
• interactive local IPython kernel interface
• high-level automation framework via tasks/scripts
• measurement setup configuration via YAML config file
• various tooling as a Python library
• basic data storage facility
• ...

Attribution

If you are publishing any work based on using qudi as a framework/tool it is good practice to mention the qudi project, e.g. in the methods description.

Even better, you could simply cite our initial publication about qudi:
Qudi: A modular python suite for experiment control and data processing

The qudi contributors will appreciate this and it helps our open-source community to gain attention. This will hopefully attract more people willing to help in improving the qudi project which in turn benefits everyone using this software.

Thank you!

Installation

For installation instructions please refer to our qudi installation guide.

Documentation

The official qudi documentation homepage can be found here.

Forum

For questions concerning qudi on any level, there is a forum to discuss with the qudi community. Feel free to ask! If you found a bug and located it already, please note GitHub's issue tracking feature.

Contributing

You want to contribute to the qudi project? Great! Please start by reading through our contributing guideline.

To file a bug report or feature request please open an issue on GitHub.

To contribute source code to the qudi-core repository please open a pull request on GitHub.

Issues and pull requests should be discussed openly in their respective comment sections on GitHub.
For any other development-related questions or discussions please subscribe to and use our qudi-dev mailing list. Please also consider using gists to showcase and discuss topics publicly within the qudi community.

News and Updates

We will occasionally inform the qudi community about releases and breaking changes (no discussions).

If you are using qudi and want to stay in the loop, please subscribe to our qudi-announce mailing list.

License

Qudi is licensed under the GNU Lesser General Public License Version 3 (LGPL v3).

A copy of the full license text can be found in the repository root directory in LICENSE and LICENSE.LESSER

For more information please check the license section in the qudi documentation.

Copyright

Check AUTHORS.md for a list of authors and the git history for their individual contributions.