qdmi - QDMI 1.1.0 Release

👀 What Changed

This release contains the work of the last couple of weeks by @ystade and @burgholzer on refining QDMI based on the discussions we had at the end of last year. Given the discussions in #109, #117, and #125, it was clear that breaking changes were inevitable. And this release definitely contains breaking changes. However, it also fixes and improves literally all aspects of QDMI. In particular:

• The interfaces have been consolidated and restructured. There are now two clear interfaces: the "device interface" (contained in the qdmi/device.h header) and the "client interface" (contained in the qdmi/client.h header). These two interfaces connect three entities: devices, clients, and a driver. This distinction and separation of concerns has been made more explicit in the interface itself as well as in its documentation.
• In addition to the regular QDMI_Session concept for establishing a connection between a client and a driver, a new QDMI_Device_Session concept was introduced that accomplishes a similar connection between the driver and a device. This resolves #109 and #117, based on the discussion in these issues, as it allows the driver to establish separate connections to a device for each client. The respective sessions may be used to authenticate with the device or to potentially switch the API endpoint used in the device implementation without having to recompile the device implementation.
• Resolves #125 by streamlining authentication and session handling. Based on the discussions over there, the new expected workflow with sessions is to first create them, then set certain parameters, and, finally, to initialize them. A session may only be used once it is successfully initialized. Any kind of authentication is handled in the new initialization routines.
• Resolves #128 by adding a unique identifier to QDMI sites. Significant effort has been put into clarifying the respective semantics around site IDs and qubits used in programs submitted to the devices.
• Many functions have been renamed to follow a consistent naming scheme throughout the whole interface. Functions are now generally prefixed by the type they operate on (for example, QDMI_device; typically the type of the first parameter), followed by the action to be performed (for example, query), and suffixed by the particular thing acted on (for example, site_property). This style is now consistently used throughout the whole interface.
• The QDMI_device_get_sites and QDMI_device_get_operations routines have been refactored to become device properties that can be queried just as every other property. This helps to keep the interface more compact and the semantics more uniform.
• Based on discussion around pulse-level control, the property query function for operations has received additional parameters for querying properties of parametrized operations depending on their parameter values. This allows devices to expose almost arbitrary operations and their properties. Effectively, this should allow realizing pulse-level QDMI devices.
• Resolves #108 by adding the respective calibration program format and needs calibration device property as discussed in that issue.
• Resolves #123 by adjusting the figure as discussed in that issue.
• Resolves #131 by adding extensive API documentation, including examples.
• Resolves #106 by significantly expanding on the client interface documentation.
• The API documentation has been meticulously cleaned up and extended wherever possible.
• All example devices, the example driver, as well as the example fomac and the example tool have been updated based on the above changes.
• All tests have been updated based on the above changes.

Overall, I believe the list above illustrates the significant progress made since last year's discussions. In particular, this release contains changes that resolve all open issues requiring breaking changes that we are aware of. Based on that and the level of attention paid to every little detail in the >150 commits leading to this release, we are confident in calling this the first official stable version of QDMI. 🎉

Full Changelog: https://github.com/Munich-Quantum-Software-Stack/QDMI/compare/v1.0.0...v1.1.0

- C++
Published by github-actions[bot] about 1 year ago

qdmi - QDMI 1.0.0 Release

👀 What Changed

This is a preliminary release that encompasses the initial version of QDMI we collectively decided to tag. It is created purely for historical reasons and posterity. The first truly stable version will be released shortly afterwards. Specifically, once #132 is merged.

🚀 Features and Enhancements

• ✨ Provide an option to specify the supported QIR profile @ystade (#126)
• 🧪 Test Installation of QDMI @ystade (#101)
• Provision to set session parameters @mnfarooqi (#100)
• Fix license @ystade (#97)
• 📝 Document the Usage of Templates and add Rationale of QDMI @ystade (#90)
• ✨ Use Prefixes for Device Symbols and Types @ystade (#86)
• ✨ Add Readout Format for State Vector and Probabilities @ystade (#82)
• ✨ Docs: Page on Example Device @ystade (#79)
• ⚡ enable compiler cache if available @burgholzer (#76)
• ✨ Add Project Templates for Devices @ystade (#72)
• ✨ Add C++ Example Device @ystade (#71)
• ✨ Example for QDMI Client @ystade (#65)
• 📝 Change Icon in "DOCUMENTATION"-Button @ystade (#64)
• 🎨 Refine and Unify Interface Structure @ystade (#61)
• 📝 Add automatic Generation of Documentation @ystade (#62)
• Changing the type of task_id @kayaercument (#59)
• QDMI_Job is included in readout routines. @kayaercument (#55)
• Not supported definition @kayaercument (#53)
• 🔧🎨🚨 Code Formatting and Linting @burgholzer (#45)
• ♻️ Properly set up CMake Build System @burgholzer (#44)
• implementing QDMI_core_device_count and QDMI_core_open_device @kayaercument (#29)
• 🙈 more extensive gitignore @burgholzer (#32)
• Implementing device property query for char @kayaercument (#33)
• Internal header moved to src @kayaercument (#27)
• Removing Backends [Issue/#11] @kayaercument (#25)
• Adding members for storing and retrieving Qubit properties @Durganshu (#4)
• Wmi backend @echavarria-lrz (#5)
• Setting sentinel values to gate coupling mappings @Durganshu (#2)

🐛 Bug Fixes

• 🎨 Stability improvements for custom enum parameters @ystade (#122)
• 🩹 fix potential target conflict @burgholzer (#121)
• 🐛 Fix an inconsistency in the docs about coupling maps @ystade (#120)
• 🧪 Test Installation of QDMI @ystade (#101)
• 📝 Remove not implemented functionality from comment @ystade (#99)
• Fix license @ystade (#97)
• Fix Inverted Dark Mode Figures @ystade (#92)
• 🐛 fix condition for deployment of docs @burgholzer (#87)
• ♻️ Fixing Various Bugs @ystade (#84)
• 📝 Change Icon in "DOCUMENTATION"-Button @ystade (#64)
• NULL Initialization of qdmi_library_list @kayaercument (#57)
• Enable parsing of quoted strings @denialhaag (#50)
• ♻️ Re-enable routine checking @burgholzer (#46)
• assigning QDMI_query_device_property_c @kayaercument (#38)
• Typo fix @kayaercument (#28)
• LLVM Dependency @kayaercument (#1)

📄 Documentation

• 🐛 Fix an inconsistency in the docs about coupling maps @ystade (#120)
• 🔖 version v1 @burgholzer (#103)
• 🍱 update QDMI figures @burgholzer (#104)
• 📝 add citation information @burgholzer (#102)
• 📝 Remove not implemented functionality from comment @ystade (#99)
• Fix Inverted Dark Mode Figures @ystade (#92)
• 📝 Document the Usage of Templates and add Rationale of QDMI @ystade (#90)
• 🐛 fix condition for deployment of docs @burgholzer (#87)
• ♻️ Fixing Various Bugs @ystade (#84)
• ✨ Docs: Page on Example Device @ystade (#79)
• ✏️ remove redundant abbreviation in readme header @burgholzer (#67)
• 📝 Change Icon in "DOCUMENTATION"-Button @ystade (#64)
• 📝 Add Button to documentation on the README.md @ystade (#63)
• 🎨 Refine and Unify Interface Structure @ystade (#61)
• 📝 Add automatic Generation of Documentation @ystade (#62)
• 📝 Project Readme @burgholzer (#36)
• 📄 Add License Information @burgholzer (#31)

🤖 CI

• 🧪 Test Installation of QDMI @ystade (#101)
• 👷 Set up continuous integration @burgholzer (#70)
• 👷 Set up dependabot @burgholzer (#69)

🧹 Code Quality

• 🧪 Test Installation of QDMI @ystade (#101)
• ✨ Use Prefixes for Device Symbols and Types @ystade (#86)
• 🎨 Use size_t for buffer sizes and countable quantities in general @burgholzer (#85)
• 🚨 Fix uncontrolled data used in path expression @burgholzer (#78)
• 🚨 Fix shadowing of global devices list in qdmi_example_driver.cpp @burgholzer (#75)

⬆️ Dependencies

7 changes

- ⬆️🪝 update pre-commit hooks @pre-commit-ci (#130) - ⬆️🪝 update pre-commit hooks @pre-commit-ci (#127) - ⬆️🪝 update pre-commit hooks @pre-commit-ci (#110) - ⬆️🪝 update pre-commit hooks @pre-commit-ci (#107) - ⬆️🪝 update pre-commit hooks @pre-commit-ci (#93) - ⬆️🪝 update pre-commit hooks @pre-commit-ci (#88) - 👷 Set up dependabot @burgholzer (#69)

Full Changelog: https://github.com/Munich-Quantum-Software-Stack/QDMI/compare/...v0.1.0

- C++
Published by github-actions[bot] about 1 year ago