Documentation

Contents:

• Installation
• Getting started
  • Why use dqc_simulator?
  • Typical workflow
  • Importing dqc_simulator
  • Creating the hardware
  • Creating the software
  • Taking simulation results
  • Running a full experiment
• User guide
  • Getting started
• Licence

API reference

• dqc_simulator package
  • dqc_simulator.hardware
  • dqc_simulator.qlib
  • dqc_simulator.software
  • dqc_simulator.util

Indices and tables

• Index

• Module Index

• Search Page

To do

Todo

Tidy up API documentation to include only user facing functions. This may require manually making some of the .rst files.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/km-campbell-dqc-simulator/checkouts/latest/docs/source/api_reference.rst, line 4.)

Todo

Could potentially change way control qubits are managed using :attr: ~netsquid.components.qmemory.MemoryPosition.in_use flag and corresponding pydynaa events. Could also make use of ~netsquid-qrepchain.processing_nodes.CommunicationMemoryManager. Finally, the modules related to parsing should potentially be moved.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/km-campbell-dqc-simulator/checkouts/latest/docs/source/dqc_simulator.software.rst, line 12.)

Todo

Refactor things in the connections module that appear only as functions to classes. I will need to retain the unpythonic functions for backwards compatability although maybe not for a public facing fork of the simulator.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/km-campbell-dqc-simulator/checkouts/latest/docs/source/getting_started.rst, line 633.)

Todo

Finish writing the user guide, adding more sections.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/km-campbell-dqc-simulator/checkouts/latest/docs/source/user_guide.rst, line 7.)