This Changelog tracks all past changes to this project as well as details about upcoming releases. The project follows Semantic Versioning with the exception that the 1.x release is still in beta with API breaking changes between minor releases. The notes below include a summary for each release, followed by details which contain one or more of the following tags:
addedfor new features.changedfor functionality and API changes.deprecatedfor soon-to-be removed features.removedfor now removed features.fixedfor any bug fixes.securityin case of vulnerabilities.
addedsupport for setting initial statevector using qiskit interface #171fixedcode quality and refactored parts of qiskit backend #170addedexamples and documentation showing qiskit visualisations in optimal control workflows #169addedoption to get and set c3 experiment object for qiskit simulations #169addedsupport for c3 custom gates in qiskit circuits #168addedproper physics simulation of circuits using qiskit interface #165addedcoupling element which depends on frequency of connected qubits #211addedmodel subclass with an arbitrary specified basis change for simulations #220fixedbug where changing a gate's name didn't change its ideal gate #233fixedbug in Instruction where ideal gate's weren't properly set #229fixedwrong direction of rotations on bloch sphere #231fixederror is raised if optimizer gives OOB results #235
Maintenance updates to code quality and implementation along with some useful utility functions and example notebooks.
addedexperimental support for Runge Kutta 4 solving of EOM #144changedthe experiment and model classes for handling different propagation methods #144changedThe generator now can handle any list of devices that forms a directed graph #129removedofficial support for Python 3.6 #156addeda method to HJSON dump current parameter values #149addedexample for the log reader CLI #137addedhuman readable saving of current best point for the optimizer #140fixedhandling of anharmonicity in transmons with two levels #146addedan example notebook with entangling two-qubit gates #154fixedBroken State Fidelity #135
Reduced coupling among different sections of the codebase by increasing the use of library style modules for all the sub-parts of the c3-toolset. Clean-ups also
involved renaming the Optimizers to more intuitive names. Several performance improvements were introduced by vectorized and batched operations.
addedA Changelog as a central location for tracking releases, new features and API breaking changesaddedTests, Batch Processing fortf_utils, tests forfrom_config()andasdict()#89fixedTransmon_expanded fitting of EJ EC #89addedMore hjson functionality, including complex numbers #89addedfixedSensitivity Analysis codebase with docs and examples #125changedNames of Optimizers #120addedTests and Cleanup ofalgorithms,qt_utils#124 #112addedSupport for Python 3.9 and TF 2.4+ with more flexible dependencies #123 #95 #113 #72 #60addedTests for Calibration #119addedfixedModel Learning codebase with docs and examples #117fixedParsing and Reading config files - Models, tasks etc #116 #103 #98 #41changedStructure of libraries formodel,tf_utils,propagators#99 #93addedHigh Level Introduction to library in docs #110removedTensorflow Optimizers that don't have correct integration #104 #124addedfixedHamiltonian generation and a lot more #84addedLinks to use binder #86 #37addedfixedImprovements in Qiskit integration #76 #68 #59 #54 #52 #50 #48 #47 #128addedCutting the simulation space by excitation number #75fixedFix counting the relative phase in IQ Mixing #40addedSupport for Parametric gates in OpenQasm style #57addedSimulation of cross talk between drive lines for Mutual Inductance #63fixedVulnerabilities hightlighted by CodeQL #65addedfixedVectorization, FFT, Noise, Dressed States and a lot more #34fixedMemory Leakage caused by use oftf.Variable#46fixedSimulation of Tunable Coupler #45addedNightly releases asc3-toolset-nightlywith post-release checks #42 #62addedTests for checking Notebooks #20
Bugfix release that addresses the memory leak due to usage of tf.Variable highlighted in #38 with the fix in #46.
Maintenance release with mostly cleanup and update of the dependencies along with some automated vulnerability checks.
addedSupport fortensorflow==2.4.0,tensorflow-probability==0.12.1,tensorflow-estimator==2.4.0,tensorboard==2.4.0,numpy==1.19.5fixedCleaned up dependencies inrequirements.txtandsetup.pyto remove unused packagesfixedPinqiskitversion in CIaddedCodeQL CI analysis for checking security vulnerabilities
Hotfix for missing c3.qiskit module in the package setup.
Support for simulating many new physical elements as well as signal chains. Preliminary support for Qiskit programming with updated documentation.
addedTunable ElementsaddedRobust Optimal ControladdedNoise SimulationaddedGeneral Signal Generation ChainaddedUpdated Tests and DocsaddedUpdated ExamplesaddedOpenQasm Qiskit supportaddedSNAIL device
This bug-fix is a mid release before the next major release 1.2 which is expected to provide enhancements for additional devices, gates and high-level programming support. In the meantime, this bug-fix addresses the following issues.
fixedTypos in version namesfixedgastandtensorflowconflict due topipresolver issues on WindowsaddedMissing Templates for PRs and IssuesfixedMissingrichinrequirements.txt
This is the first major and properly packaged release of the c3-toolset library which also included a deployment to the PyPi package repository.
addedTensorflow Optimizers - ExperimentaladdedModel ParsersremovedCleaned up Display and Plotting utilsaddedGranular TestingaddedQuick SetupaddedConfigured and Selective TestingaddedFaster CI/CDadded,fixedCompatibility with Windows and MacOSaddedBetter Examples and Docsaddedpip installation configsaddedpip-test deployment github actions