Skip to content

Latest commit

 

History

History
134 lines (95 loc) · 4.68 KB

CHANGELOG.md

File metadata and controls

134 lines (95 loc) · 4.68 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[unreleased]

Added

  • readme.ipynb to generate images shown in README.md.

[0.8.0] - 2022-07-05

Added

  • Moved configuration from setup.py to setup.cfg
  • First pass at docs using sphinx

Fixed

  • guess.smooth() no longer fails with data lengths too short to convolve.

[0.7.0] - 2021-03-02

Added

  • Added LinearSymmetricTransmissionLeakage model, and corresponding fitter, to use when the input signal couples directly to the output.

Changed

  • Added frequency keyword to KerrFitter.kerr_coefficient_from_power

[0.6.0] - 2020-09-30

Added

  • Added kerr_coefficient_from_power method to kerr.KerrFitter

[0.5.0] - 2019-05-12

Changed

  • Added properties measurement_frequency and measurement_data to background.Known

[0.4.6] - 2019-05-31

Changed

  • Updated documentation, README, and example notebooks.

[0.4.5] - 2019-05-29

Changed

  • The default guessing function now handles data irregularly spaced in frequency.

[0.4.4] - 2018-12-21

Fixed

  • Harmonized some keyword arguments in see.py

[0.4.3] - 2018-11-08

Fixed

  • Instead of causing an exception, errors on derived values (e.g. quality factors) are None when the parameter errors are None because the fit cannot estimate them.

Added

  • crosshairs keyword in see.real_and_imaginary adds lines through origin.

[0.4.2] - 2018-11-05

Changed

  • Updated example notebooks.

Fixed

  • Typo in shunt.KerrShuntFitter.

[0.4.1] 2018-10-31

Added

  • Methods in base.ResonatorFitter to evaluate the composite model and the background and foreground models.

Changed

  • Renamed some options in see.py for consistency.
  • Re-organized and upgraded guessing functions.

[0.4.0] - 2018-10-23

Added

  • A module guess.py to consolidate functions related to initial value guesses.

Changed

  • The see.py plotting functions can now plot the initial fit, and they can now create and return their own figure and axes.
  • Example notebooks updated to demonstrate new plotting abilities, including initial fit for debugging.

Fixed

  • The Reflection fitters should now work with the backgrounds that include an electrical delay.

Removed

  • The MeasurementModelResonance object and associated method in ResonatorFitter.

[0.3.2] - 2018-10-19

Changed

  • Version number corrected; minor typos

[0.3.1] - 2018-10-19

Changed

  • Example notebooks reflect renaming.

[0.3.0] - 2018-10-19

Added

  • This changelog.
  • Code in kerr.py used for fitting resonators measured with sufficiently high power that a Kerr-type nonlinearity is important.
  • Models reflection.KerrReflection and shunt.KerrShunt and corresponding fitters that use the Kerr model.
  • Photon number calculations for both linear and Kerr nonlinear resonators in both shunt and reflection configurations.
  • Example notebooks that demonstrate fitting with the Kerr model.
  • Plotting function see.triptych that creates three plots.
  • Background model Magnitude with only free magnitude.
  • Method base.initial_model_values that evaluates the model with initial values, useful for debugging.
  • Example notebooks basic.ipynb and advanced.ipynb that demonstrate basic fitting and some more advanced techniques.

Changed

  • The linear resonator model classes and fitters have been renamed:
  • Shunt -> LinearShunt and ShuntFitter -> LinearShuntFitter
  • Reflection -> LinearReflection and ReflectionFitter -> LinearReflectionFitter
  • SymmetricTransmission -> LinearSymmetricTransmission
  • Most of the backgrounds have been renamed by their free parameters:
  • UnitNorm -> Phase
  • ComplexConstant -> MagnitudePhase
  • ConstantMagnitudeConstantDelay -> MagnitudePhaseDelay
  • LinearMagnitudeConstantDelay -> MagnitudeSlopeOffsetPhaseDelay
  • A lmfit.Parameters object passed to a fitter on creation now updates the initial parameters, giving the user full control over initial values, bounds, and which parameters are varied in the fit.
  • ResonatorFitter.fit now overwrites the existing result instead of returning it.
  • Plotting functions now give the axes reasonable labels by default.
  • Energy loss rates ("kappas") have been renamed, since kappa is used to mean various things in papers.
  • background.MagnitudeSlopeOffsetPhaseDelay: magnitude_reference renamed magnitude_offset
  • ResonatorFitter.evaluate_model -> model_values

Fixed

  • One, Phase, and MagnitudePhase model functions accepted numpy scalars but not floats.