Document directory structure

ngnrsaa / qflex

Flexible Quantum Circuit Simulator (qFlex) implements an efficient tensor network, CPU-based simulator of large quantum circuits.

Apache License 2.0

97 stars 25 forks source link

Document directory structure #36

Closed 95-martin-orion closed 5 years ago

95-martin-orion commented 5 years ago

We should provide documentation for the following items (this list is incomplete):

From-scratch qFlex installation process for at least one OS (preferably several)
Directory structure and purpose of each library
Expected input files and formatting for each

95-martin-orion commented 5 years ago

PR #45 includes a vastly-simplified process for installation using Docker, and includes docs on how to run tests with this setup.

95-martin-orion commented 5 years ago

As noted in #63, many of the example invocations in this repo are now invalid. They should be replaced with ./qflex.x 11 12 2 0.005 ./circuits/ben_11_16_0.txt ./ordering/bristlecone_70.txt ./grid/bristlecone_70.txt.

95-martin-orion commented 5 years ago

Ongoing work on this is in PR #69.

95-martin-orion commented 5 years ago

Limited this to the remaining item from the original list, since we now have more focused issues tracking specific documentation in other areas.

95-martin-orion commented 5 years ago

General description of C++ libraries:

tensor: defines the qFlex Tensor type
read_circuit: handles "circuit" input file
contraction_utils: handles "ordering" input file and step-by-step contraction process
evaluate_circuit: handles "grid" input file; top-level library