Qubit Modeling Tools (QMT)

Welcome to our qubit modeling tools (qmt)! This package is designed to automate the setup of complex geometries appropriate to physical qubit simulations. This package is licensed with an MIT open source license.

Getting Started

If you're only using qmt without making code changes, you can use docker. See Wiki link.

If you're developing qmt, it is advisable to set it up with conda instead. See Conda Setup for detailed instructions.

A significant part of the repository consists of Python functions and macros to be executed within FreeCAD, either interactively or in batch mode. These require the latest version of FreeCAD (0.18), which works with Python 3.

Note that this initial release does not contain examples or introductory documentation, which we plan to add in time. If you want to get started, feel free to email John Gamble at john.gamble@microsoft.com.

Development notes

We are using GitHub Flow for the development of this code. Please see here for a tutorial.

This project uses black to improve code readability and to make changesets more readable. The package is included with the conda environment, and you can run it with black [path_to_qmt] -t py36. There's an included pre-commit hook that automatically formats your code on commit. It also integrates with popular IDEs such as PyCharm and VSCode.

Contributing

This project welcomes contributions and suggestions, but please coordinate with the maintainers before setting out to implement significant changes or new features. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.