diff --git a/.github/workflows/docs_stable.yml b/.github/workflows/docs_stable.yml index b372142511..14edd8cce4 100644 --- a/.github/workflows/docs_stable.yml +++ b/.github/workflows/docs_stable.yml @@ -25,7 +25,7 @@ jobs: - name: Build docs stable env: QISKIT_DOCS_BUILD_TUTORIALS: 'always' - run: EXPERIMENTS_DEV_DOCS=1 PROD_BUILD=1 tox -e docs + run: PROD_BUILD=1 tox -e docs - name: Bypass Jekyll Processing # Necessary for setting the correct css path run: touch docs/_build/html/.nojekyll - name: Set current version diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 312516944c..0a35679c5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -241,7 +241,7 @@ you aren't using and update the contents for those you are. For example, the end should look something like: ```yaml -features: +features_expclass: - | Introduced a new feature foo that adds support for doing something to :class:`~qiskit.circuit.QuantumCircuit` objects. It can be used by using the foo function, @@ -272,7 +272,10 @@ deprecations: :func:`qiskit.bar.foobar` calls to :func:`qiskit.foo`. ``` -You can also look at existing release notes for more examples. +Note that we are using subsections within the `features`, `upgrade`, and `fixes` sections to +organize the notes by functional area. We strongly encourage you to file your note under the most +appropriate category. You can see the current list of categories in +[release_notes/config.yaml](https://github.com/Qiskit-Extensions/qiskit-experiments/blob/main/releasenotes/config.yaml). You can use any restructured text feature in them (code sections, tables, enumerated lists, bulleted list, etc.) to express what is being changed as needed. In general, you diff --git a/docs/_static/dataframe.css b/docs/_static/customstyles.css similarity index 88% rename from docs/_static/dataframe.css rename to docs/_static/customstyles.css index 760af7617f..6dbfce8a18 100644 --- a/docs/_static/dataframe.css +++ b/docs/_static/customstyles.css @@ -1,3 +1,9 @@ +/* Wrap text of jupyter-sphinx output blocks */ + +div.output pre{ + white-space: pre-wrap; +} + /* Styling for pandas dataframes in documentation */ div.output table { diff --git a/docs/conf.py b/docs/conf.py index 37dd57cd55..1b607a0f41 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ templates_path = ["_templates"] # Manually add the gallery CSS file for now # TODO: Figure out why the styling is not working by default -html_css_files = ["nbsphinx-gallery.css", "dataframe.css"] +html_css_files = ["nbsphinx-gallery.css", "customstyles.css"] nbsphinx_timeout = 360 nbsphinx_execute = os.getenv("QISKIT_DOCS_BUILD_TUTORIALS", "never") @@ -176,7 +176,8 @@ if os.getenv("EXPERIMENTS_DEV_DOCS", None): rst_prolog = """ .. note:: - This is the documentation for the current state of the development branch + This is the documentation for the current state of the `development branch + `_ of Qiskit Experiments. The documentation or APIs here can change prior to being released. """ diff --git a/docs/release_notes.rst b/docs/release_notes.rst index ec77acc34c..42f1506434 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -1 +1,9 @@ -.. release-notes:: Release Notes +============= +Release Notes +============= + +.. release-notes:: + :earliest-version: 0.6.0 + +.. release-notes:: + :branch: stable/0.5 \ No newline at end of file diff --git a/docs/tutorials/visualization.rst b/docs/tutorials/visualization.rst index 1b57d079fa..57a16ad0ff 100644 --- a/docs/tutorials/visualization.rst +++ b/docs/tutorials/visualization.rst @@ -78,12 +78,6 @@ The plotter that generated the figure can be accessed through the analysis insta and customizing the figure can be done by setting the plotter's options. We now modify the color, symbols, and size of our plot, as well as change the axis labels for the amplitude units: -.. jupyter-execute:: - :hide-code: - :hide-output: - - %matplotlib inline - .. jupyter-execute:: # Retrieve the plotter from the analysis instance @@ -185,7 +179,7 @@ were styled differently according to the ``series_params`` attribute of ``figure By default, the supported figure options are ``xlabel``, ``ylabel``, ``xlim``, ``ylim``, ``xval_unit``, ``yval_unit``, ``xval_unit_scale``, ``yval_unit_scale``, ``xscale``, ``yscale``, -``figure_title``, and ``series_params``; see `:class:.MplDrawer` for details on how to set these +``figure_title``, and ``series_params``; see :class:`.MplDrawer` for details on how to set these options. The following T1 experiment provides examples to options that have not been demonstrated until now in this tutorial: diff --git a/qiskit_experiments/framework/base_analysis.py b/qiskit_experiments/framework/base_analysis.py index d9ae7715da..167e07e319 100644 --- a/qiskit_experiments/framework/base_analysis.py +++ b/qiskit_experiments/framework/base_analysis.py @@ -256,7 +256,7 @@ def _run_analysis( Returns: A pair ``(analysis_results, figures)`` where ``analysis_results`` - is a list of :class:`AnalysisResultData` objects, and ``figures`` + is a list of :class:`.AnalysisResultData` objects, and ``figures`` is a list of any figures for the experiment. Raises: diff --git a/releasenotes/config.yaml b/releasenotes/config.yaml index db82adba58..cad5fdcf8c 100644 --- a/releasenotes/config.yaml +++ b/releasenotes/config.yaml @@ -4,7 +4,7 @@ default_branch: main sections: - [features, New Features, 1] - [features_expnew, New Experiments, 2] - - [features_explib, Experiment Library Updates, 2] + - [features_explib, Experiment Library Features, 2] - [features_expclass, Experiment Class Features, 2] - [features_analysis, Analysis Class Features, 2] - [features_expdata, Experiment Data Features, 2] diff --git a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml deleted file mode 100644 index a8e331e942..0000000000 --- a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml +++ /dev/null @@ -1,12 +0,0 @@ ---- -features_calibration: - - | - A new method :meth:`~.Calibrations.has_template` - has been added to :class:`.Calibrations` - to check if a template schedule exists for a particular set of qubits. -fixes_explib: - - | - :class:`.FineXDragCal` and :class:`.EFRoughXSXAmplitudeCal` were updated to - attach ``"sx"`` and ``"x"`` calibrations to their circuits, respectively. - Previously, they only attached the ``"x"`` and ``"x12"`` calibrations that they - were calibrating. See issue `#1158 `_. diff --git a/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml b/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml deleted file mode 100644 index d5e032246d..0000000000 --- a/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml +++ /dev/null @@ -1,6 +0,0 @@ ---- -fixes_explib: - - | - Added a missing ``backend`` parameter to :class:`~.RoughEFFrequencyCal` and - exposed it in the experiment library. - diff --git a/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml b/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml deleted file mode 100644 index 0d96a4c3ec..0000000000 --- a/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml +++ /dev/null @@ -1,6 +0,0 @@ ---- -fixes_calibration: - - | - Fixed error generating circuits for :class:`.BaseCalibrationExperiment` - subclasses when the backend instance had no coupling map. Fixed `#1116 - `_. diff --git a/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml b/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml deleted file mode 100644 index 68b21b2da5..0000000000 --- a/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml +++ /dev/null @@ -1,9 +0,0 @@ ---- -fixes_curvefit: - - | - Fix calculation of weight for curve fitting. Previously the weights of data points to obtain - the residual of fit curve were computed by the inverse of the error bars of y data. - This may yield significant weights on certain data points when their error bar is small or zero, - and this can cause the local overfit to these data points. - To avoid this edge case of small error bars, computed weights are now clipped at 90 percentile. - This update might slightly change the outcome of fit. diff --git a/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml b/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml deleted file mode 100644 index 543d016106..0000000000 --- a/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml +++ /dev/null @@ -1,15 +0,0 @@ ---- -features_explib: - - | - A new experiment option ``circuit_order`` was added to :class:`~.InterleavedRB`. - It allows to change the order of the reference and the interleaved circuits - and hence slightly alter the impact of noise on interleaved RB results. - The default value is set to ``"RIRIRI"`` that alternate a reference and - an interleaved circuit. -fixes_explib: - - | - Changed the ordering of circuits generated by :class:`~.InterleavedRB` back to - RIRIRI (R: Reference, I: Interleaved) order. - It was accidentally changed into RRRIII order in - `#898 `_. - Before that, it had been RIRIRI order. diff --git a/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml b/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml deleted file mode 100644 index 7174bea3be..0000000000 --- a/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml +++ /dev/null @@ -1,4 +0,0 @@ ---- -fixes_visualization: - - | - Fixed a deprecated Matplotlib ``MarkerStyle`` usage in the visualization module that was causing warnings in Matplotlib 3.6+. diff --git a/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml b/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml deleted file mode 100644 index b58a0cf37f..0000000000 --- a/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml +++ /dev/null @@ -1,12 +0,0 @@ ---- -fixes_explib: - - | - Changed :class:`.StandardRB` to treat two qubit operations in the - :class:`qiskit.transpiler.Target` as having all-to-all connectivity if - there is no set of specific pairs of coupled qubits. Most importantly, this - change allows :class:`.StandardRB` to work with - :class:`qiskit_aer.AerSimulator` for multi-qubit benchmarking after - ``qiskit-aer`` 0.13.0. Version 0.13.0 of ``qiskit-aer`` changed - the default :class:`qiskit_aer.AerSimulator` to have such a - :class:`qiskit.transpiler.Target` without specific coupled pairs. - See `#1292 `__. diff --git a/releasenotes/notes/0.6/remove-tomo-reset-3f21ec4d0dacba91.yaml b/releasenotes/notes/0.6/remove-tomo-reset-3f21ec4d0dacba91.yaml deleted file mode 100644 index 20786d4dc3..0000000000 --- a/releasenotes/notes/0.6/remove-tomo-reset-3f21ec4d0dacba91.yaml +++ /dev/null @@ -1,8 +0,0 @@ ---- -other: - - | - Removed the reset instruction from the beginning of tomography experiments. - Since qubits are usually reset between circuits, this change should have no - impact on tomography experiments, but it should allow backends that do not - provide a reset instruction to run tomography experiments. See `#1250 - `_. diff --git a/tox.ini b/tox.ini index 2d400258a4..fbb6447084 100644 --- a/tox.ini +++ b/tox.ini @@ -72,6 +72,8 @@ passenv = deps = {[testenv]deps} pyarrow +setenv = + PYDEVD_DISABLE_FILE_VALIDATION = 1 commands = sphinx-build -T -W --keep-going -b html {posargs} docs/ docs/_build/html @@ -85,6 +87,8 @@ passenv = deps = {[testenv]deps} pyarrow +setenv = + PYDEVD_DISABLE_FILE_VALIDATION = 1 commands = sphinx-build -j auto -T -W --keep-going -b html {posargs} docs/ docs/_build/html @@ -100,6 +104,7 @@ deps = pyarrow setenv = QISKIT_DOCS_SKIP_EXECUTE = 1 + PYDEVD_DISABLE_FILE_VALIDATION = 1 commands = sphinx-build -T -W --keep-going -b html {posargs} docs/ docs/_build/html @@ -114,6 +119,8 @@ deps = {[testenv]deps} git+https://github.com/Qiskit/qiskit pyarrow +setenv = + PYDEVD_DISABLE_FILE_VALIDATION = 1 commands = sphinx-build -j auto -T -W --keep-going -b html {posargs} docs/ docs/_build/html