1.
Introduction to DQCsim
1.1.
The components of a simulation
1.1.1.
Frontend use cases
1.1.2.
Backend use cases
1.1.3.
Operator use cases
1.1.4.
Host use cases
1.2.
Jigsaw puzzle analogy
1.3.
DQCsim's interfaces
1.3.1.
ArbData and ArbCmds
1.3.2.
Gate- and measurement streams
1.3.3.
The host interface
1.3.4.
Miscellaneous interfaces
1.4.
Reproducibility
2.
Installation
2.1.
Plugin distribution
3.
The command-line interface
4.
Python API
4.1.
Hello, world!
4.2.
Debugging
4.3.
Sending some gates
4.4.
Controlling simulations
4.5.
Inserting an operator
4.6.
Reference
5.
C API
5.1.
Usage
5.2.
Concepts
5.2.1.
Handles: dqcs_handle_*
5.2.2.
Memory management
5.2.3.
Error handling: dqcs_error_*
5.2.4.
Callbacks
5.3.
Type definitions: dqcs_*_t
5.4.
ArbData and ArbCmd objects
5.4.1.
ArbData objects: dqcs_arb_*
5.4.2.
ArbCmd objects: dqcs_cmd_*
5.4.3.
ArbCmd queues: dqcs_cq_*
5.5.
Qubits: dqcs_qbset_*
5.6.
Matrices: dqcs_mat_*
5.7.
Gates: dqcs_gate_*
5.8.
Gate maps: dqcs_gm_*
5.9.
Measurements
5.9.1.
Singular measurements: dqcs_meas_*
5.9.2.
Measurement sets: dqcs_mset_*
5.10.
Plugins
5.10.1.
Defining a plugin: dqcs_pdef_*
5.10.2.
Running a plugin: dqcs_plugin_*
5.10.3.
Interacting with DQCsim: dqcs_plugin_*
5.10.4.
Logging: dqcs_log_*
5.11.
Simulations
5.11.1.
Configuring plugins: dqcs_pcfg_*
5.11.2.
Running local plugins: dqcs_tcfg_*
5.11.3.
Configuring a simulation: dqcs_scfg_*
5.11.4.
Running a simulation: dqcs_sim_*
5.12.
Reference
6.
C++ API
6.1.
Usage
6.2.
Comparison to the C API
6.3.
Plugin anatomy
6.4.
Host/simulation anatomy
6.5.
Reference
7.
Rust API
Release
Light (default)
Rust
Coal
Navy
Ayu
DQCsim
Command-line interface
TODO
For now, just run
dqcsim --long-help
to get the built-in documentation.