qiskit-textbook icon indicating copy to clipboard operation
qiskit-textbook copied to clipboard

[5.1 Introduction to Quantum Error Correction using Repetition Codes] Chapter uses Ignis (unmaintained since July 2022)

Open 1ucian0 opened this issue 2 years ago • 2 comments

The code example in https://qiskit.org/textbook/ch-quantum-hardware/error-correction-repetition-code.html uses qiskit.ignis, which is unmaintained since July 2022 after being deprecated in Dec 2021.

from qiskit.ignis.verification.topological_codes import RepetitionCode
from qiskit.ignis.verification.topological_codes import lookuptable_decoding
from qiskit.ignis.verification.topological_codes import GraphDecoder

I think qiskit.ignis.verification.topological_codes was replaced by NCCR-SPIN/topological_codes. If so, this should be an easy fix and a good first issue. If not the case, please remove the label and consider just removing the chapter.

1ucian0 avatar Sep 02 '22 10:09 1ucian0

According to this tutorial https://github.com/quantumjim/TopologicalCodesTutorial/blob/main/main-presentation.ipynb The NCCR-SPIN/topological_codes should be installed to use there topological codes, how would that thing work then? We would write that one should install NCCR-SPIN/topological_codes before using this chapter ? Or maybe anything else. Suggestions please @1ucian0 @frankharkins .

divshacker avatar Sep 02 '22 16:09 divshacker

  • If it's a drop-in replacement, we can add a line at the top of the notebook telling readers they'll need to pip install git+https://github.com/NCCR-SPIN/topological_codes.git to install locally. Will also need to update thebe-stable:requirements.txt.
  • If it requires reworking the page, I would opt to not fix it.

frankharkins avatar Sep 05 '22 20:09 frankharkins