From e234b5f91c6caca500a412e43b92f1652ccc42fd Mon Sep 17 00:00:00 2001 From: Alec Edgington Date: Tue, 14 Sep 2021 13:30:52 +0100 Subject: [PATCH 01/22] Add all files from former repository. --- .clang-format | 200 ++ .github/workflows/build-docs | 32 + .github/workflows/build_and_test.yml | 374 +++ .github/workflows/build_macos_m1_wheel | 23 + .github/workflows/build_macos_wheel | 24 + .github/workflows/docs.yml | 34 + .github/workflows/lint.yml | 25 + .github/workflows/linuxbuildwheel | 44 + .github/workflows/nightly.yml | 79 + .github/workflows/pytket_docs.yml | 80 + .github/workflows/release.yml | 317 ++ .gitignore | 23 + .pre-commit-config.yaml | 18 + README.md | 245 ++ bubble/Doxyfile | 2576 ++++++++++++++++ bubble/benchmarks/CMakeLists.txt | 32 + bubble/benchmarks/circuit.cpp | 46 + bubble/benchmarks/circuit_random.cpp | 50 + ...dom_nb_qubits=20_nb_layers=200_example.tkc | 27 + bubble/bubble_deps | 69 + bubble/cmake/scripts/AddBenchmark.cmake | 69 + bubble/coverage/CMakeLists.txt | 63 + bubble/coverage/CodeCoverage.cmake | 450 +++ bubble/proptests/CMakeLists.txt | 52 + bubble/proptests/ComparisonFunctions.cpp | 116 + bubble/proptests/ComparisonFunctions.hpp | 51 + bubble/proptests/proptest.cpp | 373 +++ bubble/src/ArchAwareSynth/Path.cpp | 277 ++ bubble/src/ArchAwareSynth/Path.hpp | 145 + bubble/src/ArchAwareSynth/SteinerForest.cpp | 419 +++ bubble/src/ArchAwareSynth/SteinerForest.hpp | 149 + bubble/src/ArchAwareSynth/SteinerTree.cpp | 846 ++++++ bubble/src/ArchAwareSynth/SteinerTree.hpp | 230 ++ bubble/src/Architecture/Architectures.cpp | 337 +++ bubble/src/Architecture/Architectures.hpp | 173 ++ bubble/src/CMakeLists.txt | 34 + bubble/src/Characterisation/Cycles.cpp | 331 ++ bubble/src/Characterisation/Cycles.hpp | 148 + .../DeviceCharacterisation.cpp | 95 + .../DeviceCharacterisation.hpp | 104 + .../Characterisation/FrameRandomisation.cpp | 525 ++++ .../Characterisation/FrameRandomisation.hpp | 165 + bubble/src/Circuit/AssertionSynthesis.cpp | 358 +++ bubble/src/Circuit/AssertionSynthesis.hpp | 49 + bubble/src/Circuit/Boxes.cpp | 642 ++++ bubble/src/Circuit/Boxes.hpp | 708 +++++ bubble/src/Circuit/CircPool.cpp | 659 ++++ bubble/src/Circuit/CircPool.hpp | 224 ++ bubble/src/Circuit/CircUtils.cpp | 587 ++++ bubble/src/Circuit/CircUtils.hpp | 157 + bubble/src/Circuit/Circuit.cpp | 299 ++ bubble/src/Circuit/Circuit.hpp | 1681 +++++++++++ bubble/src/Circuit/CircuitJson.cpp | 65 + bubble/src/Circuit/ClassicalExpBox.hpp | 135 + bubble/src/Circuit/Command.hpp | 98 + bubble/src/Circuit/CommandJson.cpp | 68 + bubble/src/Circuit/DAGDefs.hpp | 97 + bubble/src/Circuit/DAGProperties.cpp | 142 + bubble/src/Circuit/DAGProperties.hpp | 65 + bubble/src/Circuit/OpJson.cpp | 46 + bubble/src/Circuit/ThreeQubitConversion.cpp | 448 +++ bubble/src/Circuit/ThreeQubitConversion.hpp | 49 + bubble/src/Circuit/basic_circ_manip.cpp | 510 ++++ bubble/src/Circuit/latex_drawing.cpp | 362 +++ bubble/src/Circuit/macro_circ_info.cpp | 852 ++++++ bubble/src/Circuit/macro_manipulation.cpp | 692 +++++ bubble/src/Circuit/setters_and_getters.cpp | 649 ++++ bubble/src/Clifford/CliffTableau.cpp | 653 ++++ bubble/src/Clifford/CliffTableau.hpp | 211 ++ .../src/Converters/CliffTableauConverters.cpp | 255 ++ bubble/src/Converters/Converters.hpp | 68 + bubble/src/Converters/Gauss.cpp | 105 + bubble/src/Converters/Gauss.hpp | 50 + bubble/src/Converters/PauliGadget.cpp | 305 ++ bubble/src/Converters/PauliGadget.hpp | 58 + .../src/Converters/PauliGraphConverters.cpp | 204 ++ bubble/src/Converters/PhasePoly.cpp | 544 ++++ bubble/src/Converters/PhasePoly.hpp | 139 + bubble/src/Diagonalisation/DiagUtils.cpp | 38 + bubble/src/Diagonalisation/DiagUtils.hpp | 43 + .../src/Diagonalisation/Diagonalisation.cpp | 364 +++ .../src/Diagonalisation/Diagonalisation.hpp | 76 + bubble/src/Diagonalisation/PauliPartition.cpp | 286 ++ bubble/src/Diagonalisation/PauliPartition.hpp | 109 + bubble/src/Gate/Gate.cpp | 636 ++++ bubble/src/Gate/Gate.hpp | 79 + bubble/src/Gate/GatePtr.cpp | 33 + bubble/src/Gate/GatePtr.hpp | 36 + bubble/src/Gate/GateUnitaryMatrix.cpp | 212 ++ bubble/src/Gate/GateUnitaryMatrix.hpp | 57 + .../src/Gate/GateUnitaryMatrixComposites.cpp | 92 + bubble/src/Gate/GateUnitaryMatrixError.cpp | 23 + bubble/src/Gate/GateUnitaryMatrixError.hpp | 45 + .../Gate/GateUnitaryMatrixFixedMatrices.cpp | 201 ++ .../Gate/GateUnitaryMatrixImplementations.hpp | 144 + .../src/Gate/GateUnitaryMatrixPrimitives.cpp | 168 + bubble/src/Gate/GateUnitaryMatrixUtils.cpp | 148 + bubble/src/Gate/GateUnitaryMatrixUtils.hpp | 70 + .../Gate/GateUnitaryMatrixVariableQubits.cpp | 70 + .../Gate/GateUnitaryMatrixVariableQubits.hpp | 51 + bubble/src/Gate/GateUnitarySparseMatrix.cpp | 168 + bubble/src/Gate/GateUnitarySparseMatrix.hpp | 48 + bubble/src/Gate/OpPtrFunctions.cpp | 37 + bubble/src/Gate/OpPtrFunctions.hpp | 48 + bubble/src/Gate/Rotation.cpp | 466 +++ bubble/src/Gate/Rotation.hpp | 116 + bubble/src/Gate/SymTable.cpp | 46 + bubble/src/Gate/SymTable.hpp | 41 + bubble/src/Graphs/AdjacencyData.cpp | 182 ++ bubble/src/Graphs/AdjacencyData.hpp | 136 + bubble/src/Graphs/ArticulationPoints.cpp | 230 ++ bubble/src/Graphs/ArticulationPoints.hpp | 93 + bubble/src/Graphs/ArticulationPoints_impl.hpp | 143 + bubble/src/Graphs/BruteForceColouring.cpp | 233 ++ bubble/src/Graphs/BruteForceColouring.hpp | 65 + bubble/src/Graphs/ColouringPriority.cpp | 187 ++ bubble/src/Graphs/ColouringPriority.hpp | 126 + bubble/src/Graphs/GraphColouring.cpp | 181 ++ bubble/src/Graphs/GraphColouring.hpp | 74 + bubble/src/Graphs/GraphRoutines.cpp | 68 + bubble/src/Graphs/GraphRoutines.hpp | 46 + bubble/src/Graphs/LargeCliquesResult.cpp | 95 + bubble/src/Graphs/LargeCliquesResult.hpp | 63 + bubble/src/Graphs/TreeSearch.hpp | 119 + bubble/src/Graphs/TreeSearch_impl.hpp | 287 ++ bubble/src/Graphs/UIDConnectivity.cpp | 444 +++ bubble/src/Graphs/UIDConnectivity.hpp | 339 +++ bubble/src/Graphs/Utils.hpp | 240 ++ bubble/src/Graphs/Utils_impl.hpp | 482 +++ .../MeasurementSetup/MeasurementReduction.cpp | 76 + .../MeasurementSetup/MeasurementReduction.hpp | 39 + .../src/MeasurementSetup/MeasurementSetup.cpp | 110 + .../src/MeasurementSetup/MeasurementSetup.hpp | 97 + bubble/src/OpType/EdgeType.hpp | 60 + bubble/src/OpType/OpDesc.cpp | 102 + bubble/src/OpType/OpDesc.hpp | 127 + bubble/src/OpType/OpType.hpp | 603 ++++ bubble/src/OpType/OpTypeFunctions.cpp | 190 ++ bubble/src/OpType/OpTypeFunctions.hpp | 96 + bubble/src/OpType/OpTypeInfo.cpp | 153 + bubble/src/OpType/OpTypeInfo.hpp | 54 + bubble/src/OpType/OpTypeJson.cpp | 52 + bubble/src/Ops/ClassicalOps.cpp | 397 +++ bubble/src/Ops/ClassicalOps.hpp | 366 +++ bubble/src/Ops/Conditional.cpp | 101 + bubble/src/Ops/Conditional.hpp | 85 + bubble/src/Ops/ConjugatePauliFunctions.cpp | 197 ++ bubble/src/Ops/ConjugatePauliFunctions.hpp | 48 + bubble/src/Ops/FlowOp.cpp | 64 + bubble/src/Ops/FlowOp.hpp | 53 + bubble/src/Ops/MetaOp.cpp | 73 + bubble/src/Ops/MetaOp.hpp | 57 + bubble/src/Ops/Op.cpp | 51 + bubble/src/Ops/Op.hpp | 183 ++ bubble/src/Ops/OpJsonFactory.cpp | 63 + bubble/src/Ops/OpJsonFactory.hpp | 58 + bubble/src/Ops/OpPtr.hpp | 31 + bubble/src/PauliGraph/PauliGraph.cpp | 522 ++++ bubble/src/PauliGraph/PauliGraph.hpp | 161 + bubble/src/Predicates/CompilationUnit.cpp | 104 + bubble/src/Predicates/CompilationUnit.hpp | 75 + bubble/src/Predicates/CompilerPass.cpp | 544 ++++ bubble/src/Predicates/CompilerPass.hpp | 272 ++ bubble/src/Predicates/PassGenerators.cpp | 609 ++++ bubble/src/Predicates/PassGenerators.hpp | 179 ++ bubble/src/Predicates/PassLibrary.cpp | 476 +++ bubble/src/Predicates/PassLibrary.hpp | 81 + bubble/src/Predicates/Predicates.cpp | 750 +++++ bubble/src/Predicates/Predicates.hpp | 247 ++ bubble/src/Program/Program.hpp | 285 ++ bubble/src/Program/Program_accessors.cpp | 114 + bubble/src/Program/Program_analysis.cpp | 93 + bubble/src/Program/Program_iteration.cpp | 213 ++ bubble/src/Program/Program_manipulation.cpp | 205 ++ bubble/src/Program/Program_units.cpp | 170 ++ bubble/src/Routing/Board_Analysis.cpp | 63 + bubble/src/Routing/Placement.cpp | 215 ++ bubble/src/Routing/Placement.hpp | 362 +++ bubble/src/Routing/Qubit_Placement.cpp | 363 +++ bubble/src/Routing/Routing.cpp | 309 ++ bubble/src/Routing/Routing.hpp | 369 +++ bubble/src/Routing/Slice_Manipulation.cpp | 236 ++ bubble/src/Routing/Swap_Analysis.cpp | 606 ++++ bubble/src/Routing/Verification.cpp | 94 + bubble/src/Routing/Verification.hpp | 37 + bubble/src/Routing/subgraph_mapping.cpp | 123 + bubble/src/Simulation/BitOperations.cpp | 74 + bubble/src/Simulation/BitOperations.hpp | 56 + bubble/src/Simulation/CircuitSimulator.cpp | 90 + bubble/src/Simulation/CircuitSimulator.hpp | 79 + bubble/src/Simulation/DecomposeCircuit.cpp | 207 ++ bubble/src/Simulation/DecomposeCircuit.hpp | 37 + bubble/src/Simulation/GateNode.cpp | 280 ++ bubble/src/Simulation/GateNode.hpp | 45 + bubble/src/Simulation/GateNodesBuffer.cpp | 77 + bubble/src/Simulation/GateNodesBuffer.hpp | 95 + .../PauliExpBoxUnitaryCalculator.cpp | 229 ++ .../PauliExpBoxUnitaryCalculator.hpp | 33 + .../src/Transformations/BasicOptimisation.cpp | 957 ++++++ .../Transformations/CliffordOptimisation.cpp | 693 +++++ .../Transformations/CliffordReductionPass.cpp | 769 +++++ .../Transformations/CliffordReductionPass.hpp | 212 ++ bubble/src/Transformations/Combinator.cpp | 76 + .../Transformations/ContextualReduction.cpp | 452 +++ .../Transformations/ContextualReduction.hpp | 42 + .../src/Transformations/ControlledGates.cpp | 734 +++++ bubble/src/Transformations/Decomposition.cpp | 1064 +++++++ bubble/src/Transformations/MeasurePass.cpp | 81 + .../src/Transformations/OptimisationPass.cpp | 171 ++ .../src/Transformations/PauliOptimisation.cpp | 228 ++ .../src/Transformations/PhaseOptimisation.cpp | 181 ++ bubble/src/Transformations/Rebase.cpp | 318 ++ bubble/src/Transformations/Replacement.cpp | 319 ++ bubble/src/Transformations/Replacement.hpp | 46 + .../src/Transformations/ThreeQubitSquash.cpp | 365 +++ bubble/src/Transformations/Transform.hpp | 614 ++++ .../Transformations/std_clifford_decomp.py | 90 + bubble/src/Utils/Assert.hpp | 33 + bubble/src/Utils/BiMapHeaders.hpp | 29 + bubble/src/Utils/Constants.hpp | 72 + bubble/src/Utils/CosSinDecomposition.cpp | 115 + bubble/src/Utils/CosSinDecomposition.hpp | 49 + bubble/src/Utils/EigenConfig.hpp | 69 + bubble/src/Utils/Exceptions.hpp | 47 + bubble/src/Utils/Expression.cpp | 127 + bubble/src/Utils/Expression.hpp | 201 ++ bubble/src/Utils/GraphHeaders.hpp | 48 + bubble/src/Utils/HelperFunctions.cpp | 47 + bubble/src/Utils/HelperFunctions.hpp | 87 + bubble/src/Utils/Json.hpp | 56 + bubble/src/Utils/MatrixAnalysis.cpp | 686 +++++ bubble/src/Utils/MatrixAnalysis.hpp | 152 + bubble/src/Utils/PauliStrings.cpp | 545 ++++ bubble/src/Utils/PauliStrings.hpp | 528 ++++ bubble/src/Utils/SequencedContainers.hpp | 48 + bubble/src/Utils/Symbols.hpp | 37 + bubble/src/Utils/TketLog.cpp | 30 + bubble/src/Utils/TketLog.hpp | 37 + bubble/src/Utils/UnitID.cpp | 103 + bubble/src/Utils/UnitID.hpp | 274 ++ bubble/src/tketCMake.cmake | 55 + bubble/src/tketsrcfiles.cmake | 188 ++ bubble/tests/CMakeLists.txt | 54 + bubble/tests/Circuit/test_Boxes.cpp | 791 +++++ bubble/tests/Circuit/test_Circ.cpp | 2689 +++++++++++++++++ bubble/tests/Circuit/test_Symbolic.cpp | 135 + .../Circuit/test_ThreeQubitConversion.cpp | 461 +++ bubble/tests/CircuitsForTesting.cpp | 78 + bubble/tests/CircuitsForTesting.hpp | 54 + bubble/tests/Gate/GatesData.cpp | 90 + bubble/tests/Gate/GatesData.hpp | 46 + bubble/tests/Gate/test_GateUnitaryMatrix.cpp | 586 ++++ bubble/tests/Graphs/EdgeSequence.cpp | 43 + bubble/tests/Graphs/EdgeSequence.hpp | 70 + .../EdgeSequenceColouringParameters.cpp | 124 + .../EdgeSequenceColouringParameters.hpp | 84 + bubble/tests/Graphs/GraphTestingRoutines.cpp | 160 + bubble/tests/Graphs/GraphTestingRoutines.hpp | 72 + bubble/tests/Graphs/RNG.cpp | 167 + bubble/tests/Graphs/RNG.hpp | 165 + bubble/tests/Graphs/RandomGraphGeneration.cpp | 335 ++ bubble/tests/Graphs/RandomGraphGeneration.hpp | 186 ++ bubble/tests/Graphs/RandomPlanarGraphs.cpp | 122 + bubble/tests/Graphs/RandomPlanarGraphs.hpp | 94 + .../tests/Graphs/test_ArticulationPoints.cpp | 165 + bubble/tests/Graphs/test_GraphColouring.cpp | 367 +++ .../tests/Graphs/test_GraphFindComponents.cpp | 189 ++ .../tests/Graphs/test_GraphFindMaxClique.cpp | 260 ++ bubble/tests/Graphs/test_GraphUtils.cpp | 442 +++ bubble/tests/Graphs/test_RNG.cpp | 150 + bubble/tests/Graphs/test_TreeSearch.cpp | 290 ++ bubble/tests/Graphs/test_UIDConnectivity.cpp | 108 + bubble/tests/Ops/test_ClassicalOps.cpp | 497 +++ bubble/tests/Ops/test_Expression.cpp | 99 + bubble/tests/Ops/test_Ops.cpp | 605 ++++ .../tests/Simulation/ComparisonFunctions.cpp | 195 ++ .../tests/Simulation/ComparisonFunctions.hpp | 51 + .../Simulation/test_CircuitSimulator.cpp | 650 ++++ .../test_PauliExpBoxUnitaryCalculator.cpp | 218 ++ .../tests/Utils/test_CosSinDecomposition.cpp | 255 ++ bubble/tests/Utils/test_MatrixAnalysis.cpp | 85 + bubble/tests/random_angles.txt | 100 + bubble/tests/test_Architectures.cpp | 159 + bubble/tests/test_Assertion.cpp | 242 ++ bubble/tests/test_CliffTableau.cpp | 221 ++ bubble/tests/test_Clifford.cpp | 686 +++++ bubble/tests/test_Combinators.cpp | 61 + bubble/tests/test_CompilerPass.cpp | 903 ++++++ bubble/tests/test_ContextOpt.cpp | 337 +++ bubble/tests/test_ControlDecomp.cpp | 434 +++ bubble/tests/test_DeviceCharacterisation.cpp | 57 + bubble/tests/test_FrameRandomisation.cpp | 350 +++ bubble/tests/test_MeasurementReduction.cpp | 100 + bubble/tests/test_MeasurementSetup.cpp | 390 +++ bubble/tests/test_Partition.cpp | 98 + bubble/tests/test_Path.cpp | 997 ++++++ bubble/tests/test_PauliGraph.cpp | 1008 ++++++ bubble/tests/test_PauliString.cpp | 275 ++ bubble/tests/test_PhaseGadget.cpp | 351 +++ bubble/tests/test_PhasePolynomials.cpp | 716 +++++ bubble/tests/test_Placement.cpp | 673 +++++ bubble/tests/test_Predicates.cpp | 360 +++ bubble/tests/test_Program.cpp | 436 +++ bubble/tests/test_Rebase.cpp | 481 +++ bubble/tests/test_Routing.cpp | 2659 ++++++++++++++++ bubble/tests/test_SteinerForest.cpp | 1382 +++++++++ bubble/tests/test_SteinerTree.cpp | 877 ++++++ bubble/tests/test_Synthesis.cpp | 1817 +++++++++++ bubble/tests/test_TwoQubitCanonical.cpp | 689 +++++ bubble/tests/test_Utils.cpp | 44 + bubble/tests/test_json.cpp | 748 +++++ bubble/tests/tests_main.cpp | 17 + bubble/tests/testutil.cpp | 110 + bubble/tests/testutil.hpp | 128 + bubble/tests/tkettestsfiles.cmake | 83 + do-clang-format | 17 + pytket/.pylintrc | 58 + pytket/CMakeLists.txt | 65 + pytket/MANIFEST.in | 6 + .../circuit/Circuit/add_classical_op.cpp | 459 +++ pytket/binders/circuit/Circuit/add_op.cpp | 1386 +++++++++ pytket/binders/circuit/Circuit/main.cpp | 750 +++++ pytket/binders/circuit/boxes.cpp | 306 ++ pytket/binders/circuit/classical.cpp | 128 + pytket/binders/circuit/main.cpp | 501 +++ pytket/binders/circuit/unitid.cpp | 240 ++ pytket/binders/include/UnitRegister.hpp | 65 + pytket/binders/include/binder_json.hpp | 30 + pytket/binders/include/binder_utils.hpp | 24 + pytket/binders/include/typecast.hpp | 331 ++ pytket/binders/include/unit_downcast.hpp | 43 + pytket/binders/logging.cpp | 41 + pytket/binders/partition.cpp | 154 + pytket/binders/passes.cpp | 683 +++++ pytket/binders/pauli.cpp | 250 ++ pytket/binders/predicates.cpp | 233 ++ pytket/binders/program.cpp | 241 ++ pytket/binders/routing.cpp | 380 +++ pytket/binders/tailoring.cpp | 190 ++ pytket/binders/transform.cpp | 305 ++ pytket/binders/utils_serialization.cpp | 42 + pytket/conanfile.txt | 8 + pytket/docs/CQCLogo.png | Bin 0 -> 345527 bytes pytket/docs/Makefile | 21 + pytket/docs/backends.rst | 28 + pytket/docs/changelog.rst | 610 ++++ pytket/docs/circuit.rst | 71 + pytket/docs/circuit_class.rst | 25 + pytket/docs/classical.rst | 5 + pytket/docs/conf.py | 288 ++ pytket/docs/config.rst | 13 + pytket/docs/display.rst | 5 + pytket/docs/getting_started.rst | 69 + pytket/docs/index.rst | 175 ++ pytket/docs/install.rst | 51 + pytket/docs/licence.rst | 176 ++ pytket/docs/logging.rst | 4 + pytket/docs/opensource.rst | 22 + pytket/docs/optype.rst | 12 + pytket/docs/partition.rst | 5 + pytket/docs/passes.rst | 5 + pytket/docs/pauli.rst | 5 + pytket/docs/predicates.rst | 5 + pytket/docs/program.rst | 5 + pytket/docs/qasm.rst | 15 + pytket/docs/quipper.rst | 4 + pytket/docs/requirements.txt | 3 + pytket/docs/routing.rst | 5 + pytket/docs/tailoring.rst | 6 + pytket/docs/telemetry_data_policy.rst | 165 + pytket/docs/transform.rst | 5 + pytket/docs/utils.rst | 32 + pytket/mypy.ini | 28 + pytket/pytket/__init__.py | 28 + pytket/pytket/backends/__init__.py | 22 + pytket/pytket/backends/backend.py | 725 +++++ pytket/pytket/backends/backend_exceptions.py | 48 + pytket/pytket/backends/backendinfo.py | 171 ++ pytket/pytket/backends/backendresult.py | 658 ++++ pytket/pytket/backends/resulthandle.py | 100 + pytket/pytket/backends/status.py | 56 + pytket/pytket/circuit/__init__.py | 81 + pytket/pytket/circuit/add_condition.py | 111 + pytket/pytket/circuit/decompose_classical.py | 314 ++ pytket/pytket/circuit/display/__init__.py | 133 + pytket/pytket/circuit/display/circuit.html | 558 ++++ .../pytket/circuit/display/circuit_css.html | 582 ++++ .../circuit/display/images/measure-gate.svg | 13 + .../circuit/display/images/reset-gate.svg | 13 + .../circuit/display/images/swap-gate.svg | 9 + .../pytket/circuit/display/images/x-gate.svg | 9 + pytket/pytket/circuit/display/utils.py | 566 ++++ pytket/pytket/circuit/logic_exp.py | 397 +++ pytket/pytket/config/__init__.py | 24 + pytket/pytket/config/pytket_config.py | 144 + pytket/pytket/logging/__init__.py | 17 + pytket/pytket/partition/__init__.py | 21 + pytket/pytket/passes/__init__.py | 19 + pytket/pytket/passes/script.py | 432 +++ pytket/pytket/pauli/__init__.py | 17 + pytket/pytket/predicates/__init__.py | 17 + pytket/pytket/program/__init__.py | 20 + pytket/pytket/py.typed | 0 pytket/pytket/qasm/__init__.py | 26 + pytket/pytket/qasm/qasm.py | 630 ++++ pytket/pytket/quipper/__init__.py | 17 + pytket/pytket/quipper/quipper.py | 715 +++++ pytket/pytket/routing/__init__.py | 23 + pytket/pytket/tailoring/__init__.py | 21 + pytket/pytket/telemetry/__init__.py | 119 + pytket/pytket/transform/__init__.py | 20 + pytket/pytket/utils/__init__.py | 39 + pytket/pytket/utils/expectations.py | 242 ++ pytket/pytket/utils/graph.py | 313 ++ pytket/pytket/utils/measurements.py | 63 + pytket/pytket/utils/operators.py | 416 +++ pytket/pytket/utils/outcomearray.py | 197 ++ pytket/pytket/utils/prepare.py | 53 + pytket/pytket/utils/results.py | 282 ++ pytket/pytket/utils/serialization/__init__.py | 15 + pytket/pytket/utils/spam.py | 644 ++++ pytket/pytket/utils/symbolic.py | 430 +++ pytket/pytket/utils/term_sequence.py | 63 + pytket/setup.py | 253 ++ pytket/tests/.gitignore | 2 + pytket/tests/add_circuit_test.py | 65 + pytket/tests/ansatz_sequence_test.py | 126 + pytket/tests/assertion_test.py | 117 + pytket/tests/backend_test.py | 552 ++++ pytket/tests/backendinfo_test.py | 166 + pytket/tests/characterisation_test.py | 146 + pytket/tests/circuit_test.py | 681 +++++ pytket/tests/classical_test.py | 608 ++++ pytket/tests/cli-test | 89 + pytket/tests/conftest.py | 108 + pytket/tests/measurement_setup_test.py | 94 + pytket/tests/mitigation_test.py | 536 ++++ pytket/tests/passes_script_test.py | 123 + pytket/tests/predicates_test.py | 974 ++++++ pytket/tests/program_test.py | 134 + pytket/tests/pytket_config_test.py | 96 + pytket/tests/qasm_test.py | 342 +++ pytket/tests/qasm_test_files/test1.qasm | 15 + pytket/tests/qasm_test_files/test10.qasm | 8 + pytket/tests/qasm_test_files/test11.qasm | 868 ++++++ pytket/tests/qasm_test_files/test13.qasm | 280 ++ pytket/tests/qasm_test_files/test14.qasm | 505 ++++ pytket/tests/qasm_test_files/test15.qasm | 14 + pytket/tests/qasm_test_files/test2.qasm | 4 + pytket/tests/qasm_test_files/test3.qasm | 12 + pytket/tests/qasm_test_files/test4.qasm | 6 + pytket/tests/qasm_test_files/test5.qasm | 7 + pytket/tests/qasm_test_files/test6.qasm | 15 + pytket/tests/qasm_test_files/test7.qasm | 11 + pytket/tests/qasm_test_files/test8.qasm | 475 +++ pytket/tests/qasm_test_files/test9.qasm | 7 + pytket/tests/qubitpaulioperator_test.py | 229 ++ pytket/tests/quipper_simulate | 36 + pytket/tests/quipper_test.py | 115 + pytket/tests/quipper_test_files/test1.quip | 1660 ++++++++++ pytket/tests/quipper_test_files/test2.quip | 26 + pytket/tests/quipper_test_files/test3.quip | 48 + pytket/tests/quipper_test_files/test4-0.quip | 5 + .../quipper_test_files/test4-0.quip.simout | 16 + pytket/tests/quipper_test_files/test4-1.quip | 3 + .../quipper_test_files/test4-1.quip.simout | 16 + pytket/tests/quipper_test_files/test4-10.quip | 4 + .../quipper_test_files/test4-10.quip.simout | 8 + pytket/tests/quipper_test_files/test4-2.quip | 4 + .../quipper_test_files/test4-2.quip.simout | 6 + pytket/tests/quipper_test_files/test4-3.quip | 3 + .../quipper_test_files/test4-3.quip.simout | 8 + pytket/tests/quipper_test_files/test4-4.quip | 7 + .../quipper_test_files/test4-4.quip.simout | 12 + pytket/tests/quipper_test_files/test4-5.quip | 6 + .../quipper_test_files/test4-5.quip.simout | 8 + pytket/tests/quipper_test_files/test4-6.quip | 3 + .../quipper_test_files/test4-6.quip.simout | 4 + pytket/tests/quipper_test_files/test4-7.quip | 3 + .../quipper_test_files/test4-7.quip.simout | 4 + pytket/tests/quipper_test_files/test4-8.quip | 23 + .../quipper_test_files/test4-8.quip.simout | 104 + pytket/tests/quipper_test_files/test4-9.quip | 14 + .../quipper_test_files/test4-9.quip.simout | 40 + pytket/tests/quipper_test_files/test5.quip | 3 + pytket/tests/requirements-openfermion.txt | 1 + pytket/tests/requirements.txt | 7 + pytket/tests/routing_test.py | 774 +++++ pytket/tests/simulator/__init__.py | 16 + pytket/tests/simulator/tket_sim_backend.py | 205 ++ pytket/tests/simulator/tket_sim_wrapper.py | 51 + pytket/tests/strategies.py | 240 ++ pytket/tests/timing_circuit.py | 41 + pytket/tests/tket_sim_test.py | 265 ++ pytket/tests/transform_test.py | 718 +++++ pytket/tests/utils_test.py | 612 ++++ pytket/tket | 267 ++ recipes/tket-benchmarks/conanfile.py | 23 + recipes/tket-coverage/conanfile.py | 82 + recipes/tket-proptests/conanfile.py | 44 + .../tket-proptests/test_package/conanfile.py | 57 + recipes/tket-tests/conanfile.py | 46 + recipes/tket-tests/test_package/conanfile.py | 52 + recipes/tket/conanfile.py | 86 + recipes/tket/patches/adjacency_list.diff | 24 + recipes/tket/patches/vf2_sub_graph_iso.diff | 238 ++ recipes/tket/test_package/CMakeLists.txt | 34 + recipes/tket/test_package/conanfile.py | 49 + recipes/tket/test_package/test.cpp | 59 + schemas/circuit_v1.json | 706 +++++ schemas/compiler_pass_v1.json | 1037 +++++++ schemas/pytket_config_v1.json | 24 + 512 files changed, 116596 insertions(+) create mode 100644 .clang-format create mode 100755 .github/workflows/build-docs create mode 100644 .github/workflows/build_and_test.yml create mode 100755 .github/workflows/build_macos_m1_wheel create mode 100755 .github/workflows/build_macos_wheel create mode 100644 .github/workflows/docs.yml create mode 100644 .github/workflows/lint.yml create mode 100755 .github/workflows/linuxbuildwheel create mode 100644 .github/workflows/nightly.yml create mode 100644 .github/workflows/pytket_docs.yml create mode 100644 .github/workflows/release.yml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 README.md create mode 100644 bubble/Doxyfile create mode 100644 bubble/benchmarks/CMakeLists.txt create mode 100644 bubble/benchmarks/circuit.cpp create mode 100644 bubble/benchmarks/circuit_random.cpp create mode 100644 bubble/benchmarks/input_files/circuit_random_nb_qubits=20_nb_layers=200_example.tkc create mode 100755 bubble/bubble_deps create mode 100644 bubble/cmake/scripts/AddBenchmark.cmake create mode 100644 bubble/coverage/CMakeLists.txt create mode 100644 bubble/coverage/CodeCoverage.cmake create mode 100644 bubble/proptests/CMakeLists.txt create mode 100644 bubble/proptests/ComparisonFunctions.cpp create mode 100644 bubble/proptests/ComparisonFunctions.hpp create mode 100644 bubble/proptests/proptest.cpp create mode 100644 bubble/src/ArchAwareSynth/Path.cpp create mode 100644 bubble/src/ArchAwareSynth/Path.hpp create mode 100644 bubble/src/ArchAwareSynth/SteinerForest.cpp create mode 100644 bubble/src/ArchAwareSynth/SteinerForest.hpp create mode 100644 bubble/src/ArchAwareSynth/SteinerTree.cpp create mode 100644 bubble/src/ArchAwareSynth/SteinerTree.hpp create mode 100644 bubble/src/Architecture/Architectures.cpp create mode 100644 bubble/src/Architecture/Architectures.hpp create mode 100644 bubble/src/CMakeLists.txt create mode 100644 bubble/src/Characterisation/Cycles.cpp create mode 100644 bubble/src/Characterisation/Cycles.hpp create mode 100644 bubble/src/Characterisation/DeviceCharacterisation.cpp create mode 100644 bubble/src/Characterisation/DeviceCharacterisation.hpp create mode 100644 bubble/src/Characterisation/FrameRandomisation.cpp create mode 100644 bubble/src/Characterisation/FrameRandomisation.hpp create mode 100644 bubble/src/Circuit/AssertionSynthesis.cpp create mode 100644 bubble/src/Circuit/AssertionSynthesis.hpp create mode 100644 bubble/src/Circuit/Boxes.cpp create mode 100644 bubble/src/Circuit/Boxes.hpp create mode 100644 bubble/src/Circuit/CircPool.cpp create mode 100644 bubble/src/Circuit/CircPool.hpp create mode 100644 bubble/src/Circuit/CircUtils.cpp create mode 100644 bubble/src/Circuit/CircUtils.hpp create mode 100644 bubble/src/Circuit/Circuit.cpp create mode 100644 bubble/src/Circuit/Circuit.hpp create mode 100644 bubble/src/Circuit/CircuitJson.cpp create mode 100644 bubble/src/Circuit/ClassicalExpBox.hpp create mode 100644 bubble/src/Circuit/Command.hpp create mode 100644 bubble/src/Circuit/CommandJson.cpp create mode 100644 bubble/src/Circuit/DAGDefs.hpp create mode 100644 bubble/src/Circuit/DAGProperties.cpp create mode 100644 bubble/src/Circuit/DAGProperties.hpp create mode 100644 bubble/src/Circuit/OpJson.cpp create mode 100644 bubble/src/Circuit/ThreeQubitConversion.cpp create mode 100644 bubble/src/Circuit/ThreeQubitConversion.hpp create mode 100644 bubble/src/Circuit/basic_circ_manip.cpp create mode 100644 bubble/src/Circuit/latex_drawing.cpp create mode 100644 bubble/src/Circuit/macro_circ_info.cpp create mode 100644 bubble/src/Circuit/macro_manipulation.cpp create mode 100644 bubble/src/Circuit/setters_and_getters.cpp create mode 100644 bubble/src/Clifford/CliffTableau.cpp create mode 100644 bubble/src/Clifford/CliffTableau.hpp create mode 100644 bubble/src/Converters/CliffTableauConverters.cpp create mode 100644 bubble/src/Converters/Converters.hpp create mode 100644 bubble/src/Converters/Gauss.cpp create mode 100644 bubble/src/Converters/Gauss.hpp create mode 100644 bubble/src/Converters/PauliGadget.cpp create mode 100644 bubble/src/Converters/PauliGadget.hpp create mode 100644 bubble/src/Converters/PauliGraphConverters.cpp create mode 100644 bubble/src/Converters/PhasePoly.cpp create mode 100644 bubble/src/Converters/PhasePoly.hpp create mode 100644 bubble/src/Diagonalisation/DiagUtils.cpp create mode 100644 bubble/src/Diagonalisation/DiagUtils.hpp create mode 100644 bubble/src/Diagonalisation/Diagonalisation.cpp create mode 100644 bubble/src/Diagonalisation/Diagonalisation.hpp create mode 100644 bubble/src/Diagonalisation/PauliPartition.cpp create mode 100644 bubble/src/Diagonalisation/PauliPartition.hpp create mode 100644 bubble/src/Gate/Gate.cpp create mode 100644 bubble/src/Gate/Gate.hpp create mode 100644 bubble/src/Gate/GatePtr.cpp create mode 100644 bubble/src/Gate/GatePtr.hpp create mode 100644 bubble/src/Gate/GateUnitaryMatrix.cpp create mode 100644 bubble/src/Gate/GateUnitaryMatrix.hpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixComposites.cpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixError.cpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixError.hpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixFixedMatrices.cpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixImplementations.hpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixPrimitives.cpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixUtils.cpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixUtils.hpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixVariableQubits.cpp create mode 100644 bubble/src/Gate/GateUnitaryMatrixVariableQubits.hpp create mode 100644 bubble/src/Gate/GateUnitarySparseMatrix.cpp create mode 100644 bubble/src/Gate/GateUnitarySparseMatrix.hpp create mode 100644 bubble/src/Gate/OpPtrFunctions.cpp create mode 100644 bubble/src/Gate/OpPtrFunctions.hpp create mode 100644 bubble/src/Gate/Rotation.cpp create mode 100644 bubble/src/Gate/Rotation.hpp create mode 100644 bubble/src/Gate/SymTable.cpp create mode 100644 bubble/src/Gate/SymTable.hpp create mode 100644 bubble/src/Graphs/AdjacencyData.cpp create mode 100644 bubble/src/Graphs/AdjacencyData.hpp create mode 100644 bubble/src/Graphs/ArticulationPoints.cpp create mode 100644 bubble/src/Graphs/ArticulationPoints.hpp create mode 100644 bubble/src/Graphs/ArticulationPoints_impl.hpp create mode 100644 bubble/src/Graphs/BruteForceColouring.cpp create mode 100644 bubble/src/Graphs/BruteForceColouring.hpp create mode 100644 bubble/src/Graphs/ColouringPriority.cpp create mode 100644 bubble/src/Graphs/ColouringPriority.hpp create mode 100644 bubble/src/Graphs/GraphColouring.cpp create mode 100644 bubble/src/Graphs/GraphColouring.hpp create mode 100644 bubble/src/Graphs/GraphRoutines.cpp create mode 100644 bubble/src/Graphs/GraphRoutines.hpp create mode 100644 bubble/src/Graphs/LargeCliquesResult.cpp create mode 100644 bubble/src/Graphs/LargeCliquesResult.hpp create mode 100644 bubble/src/Graphs/TreeSearch.hpp create mode 100644 bubble/src/Graphs/TreeSearch_impl.hpp create mode 100644 bubble/src/Graphs/UIDConnectivity.cpp create mode 100644 bubble/src/Graphs/UIDConnectivity.hpp create mode 100644 bubble/src/Graphs/Utils.hpp create mode 100644 bubble/src/Graphs/Utils_impl.hpp create mode 100644 bubble/src/MeasurementSetup/MeasurementReduction.cpp create mode 100644 bubble/src/MeasurementSetup/MeasurementReduction.hpp create mode 100644 bubble/src/MeasurementSetup/MeasurementSetup.cpp create mode 100644 bubble/src/MeasurementSetup/MeasurementSetup.hpp create mode 100644 bubble/src/OpType/EdgeType.hpp create mode 100644 bubble/src/OpType/OpDesc.cpp create mode 100644 bubble/src/OpType/OpDesc.hpp create mode 100644 bubble/src/OpType/OpType.hpp create mode 100644 bubble/src/OpType/OpTypeFunctions.cpp create mode 100644 bubble/src/OpType/OpTypeFunctions.hpp create mode 100644 bubble/src/OpType/OpTypeInfo.cpp create mode 100644 bubble/src/OpType/OpTypeInfo.hpp create mode 100644 bubble/src/OpType/OpTypeJson.cpp create mode 100644 bubble/src/Ops/ClassicalOps.cpp create mode 100644 bubble/src/Ops/ClassicalOps.hpp create mode 100644 bubble/src/Ops/Conditional.cpp create mode 100644 bubble/src/Ops/Conditional.hpp create mode 100644 bubble/src/Ops/ConjugatePauliFunctions.cpp create mode 100644 bubble/src/Ops/ConjugatePauliFunctions.hpp create mode 100644 bubble/src/Ops/FlowOp.cpp create mode 100644 bubble/src/Ops/FlowOp.hpp create mode 100644 bubble/src/Ops/MetaOp.cpp create mode 100644 bubble/src/Ops/MetaOp.hpp create mode 100644 bubble/src/Ops/Op.cpp create mode 100644 bubble/src/Ops/Op.hpp create mode 100644 bubble/src/Ops/OpJsonFactory.cpp create mode 100644 bubble/src/Ops/OpJsonFactory.hpp create mode 100644 bubble/src/Ops/OpPtr.hpp create mode 100644 bubble/src/PauliGraph/PauliGraph.cpp create mode 100644 bubble/src/PauliGraph/PauliGraph.hpp create mode 100644 bubble/src/Predicates/CompilationUnit.cpp create mode 100644 bubble/src/Predicates/CompilationUnit.hpp create mode 100644 bubble/src/Predicates/CompilerPass.cpp create mode 100644 bubble/src/Predicates/CompilerPass.hpp create mode 100644 bubble/src/Predicates/PassGenerators.cpp create mode 100644 bubble/src/Predicates/PassGenerators.hpp create mode 100644 bubble/src/Predicates/PassLibrary.cpp create mode 100644 bubble/src/Predicates/PassLibrary.hpp create mode 100644 bubble/src/Predicates/Predicates.cpp create mode 100644 bubble/src/Predicates/Predicates.hpp create mode 100644 bubble/src/Program/Program.hpp create mode 100644 bubble/src/Program/Program_accessors.cpp create mode 100644 bubble/src/Program/Program_analysis.cpp create mode 100644 bubble/src/Program/Program_iteration.cpp create mode 100644 bubble/src/Program/Program_manipulation.cpp create mode 100644 bubble/src/Program/Program_units.cpp create mode 100644 bubble/src/Routing/Board_Analysis.cpp create mode 100644 bubble/src/Routing/Placement.cpp create mode 100644 bubble/src/Routing/Placement.hpp create mode 100644 bubble/src/Routing/Qubit_Placement.cpp create mode 100644 bubble/src/Routing/Routing.cpp create mode 100644 bubble/src/Routing/Routing.hpp create mode 100644 bubble/src/Routing/Slice_Manipulation.cpp create mode 100644 bubble/src/Routing/Swap_Analysis.cpp create mode 100644 bubble/src/Routing/Verification.cpp create mode 100644 bubble/src/Routing/Verification.hpp create mode 100644 bubble/src/Routing/subgraph_mapping.cpp create mode 100644 bubble/src/Simulation/BitOperations.cpp create mode 100644 bubble/src/Simulation/BitOperations.hpp create mode 100644 bubble/src/Simulation/CircuitSimulator.cpp create mode 100644 bubble/src/Simulation/CircuitSimulator.hpp create mode 100644 bubble/src/Simulation/DecomposeCircuit.cpp create mode 100644 bubble/src/Simulation/DecomposeCircuit.hpp create mode 100644 bubble/src/Simulation/GateNode.cpp create mode 100644 bubble/src/Simulation/GateNode.hpp create mode 100644 bubble/src/Simulation/GateNodesBuffer.cpp create mode 100644 bubble/src/Simulation/GateNodesBuffer.hpp create mode 100644 bubble/src/Simulation/PauliExpBoxUnitaryCalculator.cpp create mode 100644 bubble/src/Simulation/PauliExpBoxUnitaryCalculator.hpp create mode 100644 bubble/src/Transformations/BasicOptimisation.cpp create mode 100644 bubble/src/Transformations/CliffordOptimisation.cpp create mode 100644 bubble/src/Transformations/CliffordReductionPass.cpp create mode 100644 bubble/src/Transformations/CliffordReductionPass.hpp create mode 100644 bubble/src/Transformations/Combinator.cpp create mode 100644 bubble/src/Transformations/ContextualReduction.cpp create mode 100644 bubble/src/Transformations/ContextualReduction.hpp create mode 100644 bubble/src/Transformations/ControlledGates.cpp create mode 100644 bubble/src/Transformations/Decomposition.cpp create mode 100644 bubble/src/Transformations/MeasurePass.cpp create mode 100644 bubble/src/Transformations/OptimisationPass.cpp create mode 100644 bubble/src/Transformations/PauliOptimisation.cpp create mode 100644 bubble/src/Transformations/PhaseOptimisation.cpp create mode 100644 bubble/src/Transformations/Rebase.cpp create mode 100644 bubble/src/Transformations/Replacement.cpp create mode 100644 bubble/src/Transformations/Replacement.hpp create mode 100644 bubble/src/Transformations/ThreeQubitSquash.cpp create mode 100644 bubble/src/Transformations/Transform.hpp create mode 100644 bubble/src/Transformations/std_clifford_decomp.py create mode 100644 bubble/src/Utils/Assert.hpp create mode 100644 bubble/src/Utils/BiMapHeaders.hpp create mode 100644 bubble/src/Utils/Constants.hpp create mode 100644 bubble/src/Utils/CosSinDecomposition.cpp create mode 100644 bubble/src/Utils/CosSinDecomposition.hpp create mode 100644 bubble/src/Utils/EigenConfig.hpp create mode 100644 bubble/src/Utils/Exceptions.hpp create mode 100644 bubble/src/Utils/Expression.cpp create mode 100644 bubble/src/Utils/Expression.hpp create mode 100644 bubble/src/Utils/GraphHeaders.hpp create mode 100644 bubble/src/Utils/HelperFunctions.cpp create mode 100644 bubble/src/Utils/HelperFunctions.hpp create mode 100644 bubble/src/Utils/Json.hpp create mode 100644 bubble/src/Utils/MatrixAnalysis.cpp create mode 100644 bubble/src/Utils/MatrixAnalysis.hpp create mode 100644 bubble/src/Utils/PauliStrings.cpp create mode 100644 bubble/src/Utils/PauliStrings.hpp create mode 100644 bubble/src/Utils/SequencedContainers.hpp create mode 100644 bubble/src/Utils/Symbols.hpp create mode 100644 bubble/src/Utils/TketLog.cpp create mode 100644 bubble/src/Utils/TketLog.hpp create mode 100644 bubble/src/Utils/UnitID.cpp create mode 100644 bubble/src/Utils/UnitID.hpp create mode 100644 bubble/src/tketCMake.cmake create mode 100644 bubble/src/tketsrcfiles.cmake create mode 100644 bubble/tests/CMakeLists.txt create mode 100644 bubble/tests/Circuit/test_Boxes.cpp create mode 100644 bubble/tests/Circuit/test_Circ.cpp create mode 100644 bubble/tests/Circuit/test_Symbolic.cpp create mode 100644 bubble/tests/Circuit/test_ThreeQubitConversion.cpp create mode 100644 bubble/tests/CircuitsForTesting.cpp create mode 100644 bubble/tests/CircuitsForTesting.hpp create mode 100644 bubble/tests/Gate/GatesData.cpp create mode 100644 bubble/tests/Gate/GatesData.hpp create mode 100644 bubble/tests/Gate/test_GateUnitaryMatrix.cpp create mode 100644 bubble/tests/Graphs/EdgeSequence.cpp create mode 100644 bubble/tests/Graphs/EdgeSequence.hpp create mode 100644 bubble/tests/Graphs/EdgeSequenceColouringParameters.cpp create mode 100644 bubble/tests/Graphs/EdgeSequenceColouringParameters.hpp create mode 100644 bubble/tests/Graphs/GraphTestingRoutines.cpp create mode 100644 bubble/tests/Graphs/GraphTestingRoutines.hpp create mode 100644 bubble/tests/Graphs/RNG.cpp create mode 100644 bubble/tests/Graphs/RNG.hpp create mode 100644 bubble/tests/Graphs/RandomGraphGeneration.cpp create mode 100644 bubble/tests/Graphs/RandomGraphGeneration.hpp create mode 100644 bubble/tests/Graphs/RandomPlanarGraphs.cpp create mode 100644 bubble/tests/Graphs/RandomPlanarGraphs.hpp create mode 100644 bubble/tests/Graphs/test_ArticulationPoints.cpp create mode 100644 bubble/tests/Graphs/test_GraphColouring.cpp create mode 100644 bubble/tests/Graphs/test_GraphFindComponents.cpp create mode 100644 bubble/tests/Graphs/test_GraphFindMaxClique.cpp create mode 100644 bubble/tests/Graphs/test_GraphUtils.cpp create mode 100644 bubble/tests/Graphs/test_RNG.cpp create mode 100644 bubble/tests/Graphs/test_TreeSearch.cpp create mode 100644 bubble/tests/Graphs/test_UIDConnectivity.cpp create mode 100644 bubble/tests/Ops/test_ClassicalOps.cpp create mode 100644 bubble/tests/Ops/test_Expression.cpp create mode 100644 bubble/tests/Ops/test_Ops.cpp create mode 100644 bubble/tests/Simulation/ComparisonFunctions.cpp create mode 100644 bubble/tests/Simulation/ComparisonFunctions.hpp create mode 100644 bubble/tests/Simulation/test_CircuitSimulator.cpp create mode 100644 bubble/tests/Simulation/test_PauliExpBoxUnitaryCalculator.cpp create mode 100644 bubble/tests/Utils/test_CosSinDecomposition.cpp create mode 100644 bubble/tests/Utils/test_MatrixAnalysis.cpp create mode 100644 bubble/tests/random_angles.txt create mode 100644 bubble/tests/test_Architectures.cpp create mode 100644 bubble/tests/test_Assertion.cpp create mode 100644 bubble/tests/test_CliffTableau.cpp create mode 100644 bubble/tests/test_Clifford.cpp create mode 100644 bubble/tests/test_Combinators.cpp create mode 100644 bubble/tests/test_CompilerPass.cpp create mode 100644 bubble/tests/test_ContextOpt.cpp create mode 100644 bubble/tests/test_ControlDecomp.cpp create mode 100644 bubble/tests/test_DeviceCharacterisation.cpp create mode 100644 bubble/tests/test_FrameRandomisation.cpp create mode 100644 bubble/tests/test_MeasurementReduction.cpp create mode 100644 bubble/tests/test_MeasurementSetup.cpp create mode 100644 bubble/tests/test_Partition.cpp create mode 100644 bubble/tests/test_Path.cpp create mode 100644 bubble/tests/test_PauliGraph.cpp create mode 100644 bubble/tests/test_PauliString.cpp create mode 100644 bubble/tests/test_PhaseGadget.cpp create mode 100644 bubble/tests/test_PhasePolynomials.cpp create mode 100644 bubble/tests/test_Placement.cpp create mode 100644 bubble/tests/test_Predicates.cpp create mode 100644 bubble/tests/test_Program.cpp create mode 100644 bubble/tests/test_Rebase.cpp create mode 100644 bubble/tests/test_Routing.cpp create mode 100644 bubble/tests/test_SteinerForest.cpp create mode 100644 bubble/tests/test_SteinerTree.cpp create mode 100644 bubble/tests/test_Synthesis.cpp create mode 100644 bubble/tests/test_TwoQubitCanonical.cpp create mode 100644 bubble/tests/test_Utils.cpp create mode 100644 bubble/tests/test_json.cpp create mode 100644 bubble/tests/tests_main.cpp create mode 100644 bubble/tests/testutil.cpp create mode 100644 bubble/tests/testutil.hpp create mode 100644 bubble/tests/tkettestsfiles.cmake create mode 100755 do-clang-format create mode 100644 pytket/.pylintrc create mode 100644 pytket/CMakeLists.txt create mode 100644 pytket/MANIFEST.in create mode 100644 pytket/binders/circuit/Circuit/add_classical_op.cpp create mode 100644 pytket/binders/circuit/Circuit/add_op.cpp create mode 100644 pytket/binders/circuit/Circuit/main.cpp create mode 100644 pytket/binders/circuit/boxes.cpp create mode 100644 pytket/binders/circuit/classical.cpp create mode 100644 pytket/binders/circuit/main.cpp create mode 100644 pytket/binders/circuit/unitid.cpp create mode 100644 pytket/binders/include/UnitRegister.hpp create mode 100644 pytket/binders/include/binder_json.hpp create mode 100644 pytket/binders/include/binder_utils.hpp create mode 100644 pytket/binders/include/typecast.hpp create mode 100644 pytket/binders/include/unit_downcast.hpp create mode 100644 pytket/binders/logging.cpp create mode 100644 pytket/binders/partition.cpp create mode 100644 pytket/binders/passes.cpp create mode 100644 pytket/binders/pauli.cpp create mode 100644 pytket/binders/predicates.cpp create mode 100644 pytket/binders/program.cpp create mode 100644 pytket/binders/routing.cpp create mode 100644 pytket/binders/tailoring.cpp create mode 100644 pytket/binders/transform.cpp create mode 100644 pytket/binders/utils_serialization.cpp create mode 100644 pytket/conanfile.txt create mode 100644 pytket/docs/CQCLogo.png create mode 100644 pytket/docs/Makefile create mode 100644 pytket/docs/backends.rst create mode 100644 pytket/docs/changelog.rst create mode 100644 pytket/docs/circuit.rst create mode 100644 pytket/docs/circuit_class.rst create mode 100644 pytket/docs/classical.rst create mode 100644 pytket/docs/conf.py create mode 100644 pytket/docs/config.rst create mode 100644 pytket/docs/display.rst create mode 100644 pytket/docs/getting_started.rst create mode 100644 pytket/docs/index.rst create mode 100644 pytket/docs/install.rst create mode 100644 pytket/docs/licence.rst create mode 100644 pytket/docs/logging.rst create mode 100644 pytket/docs/opensource.rst create mode 100644 pytket/docs/optype.rst create mode 100644 pytket/docs/partition.rst create mode 100644 pytket/docs/passes.rst create mode 100644 pytket/docs/pauli.rst create mode 100644 pytket/docs/predicates.rst create mode 100644 pytket/docs/program.rst create mode 100644 pytket/docs/qasm.rst create mode 100644 pytket/docs/quipper.rst create mode 100644 pytket/docs/requirements.txt create mode 100644 pytket/docs/routing.rst create mode 100644 pytket/docs/tailoring.rst create mode 100644 pytket/docs/telemetry_data_policy.rst create mode 100644 pytket/docs/transform.rst create mode 100644 pytket/docs/utils.rst create mode 100644 pytket/mypy.ini create mode 100755 pytket/pytket/__init__.py create mode 100644 pytket/pytket/backends/__init__.py create mode 100644 pytket/pytket/backends/backend.py create mode 100644 pytket/pytket/backends/backend_exceptions.py create mode 100644 pytket/pytket/backends/backendinfo.py create mode 100644 pytket/pytket/backends/backendresult.py create mode 100644 pytket/pytket/backends/resulthandle.py create mode 100644 pytket/pytket/backends/status.py create mode 100644 pytket/pytket/circuit/__init__.py create mode 100644 pytket/pytket/circuit/add_condition.py create mode 100644 pytket/pytket/circuit/decompose_classical.py create mode 100644 pytket/pytket/circuit/display/__init__.py create mode 100644 pytket/pytket/circuit/display/circuit.html create mode 100644 pytket/pytket/circuit/display/circuit_css.html create mode 100644 pytket/pytket/circuit/display/images/measure-gate.svg create mode 100644 pytket/pytket/circuit/display/images/reset-gate.svg create mode 100644 pytket/pytket/circuit/display/images/swap-gate.svg create mode 100644 pytket/pytket/circuit/display/images/x-gate.svg create mode 100644 pytket/pytket/circuit/display/utils.py create mode 100644 pytket/pytket/circuit/logic_exp.py create mode 100644 pytket/pytket/config/__init__.py create mode 100644 pytket/pytket/config/pytket_config.py create mode 100644 pytket/pytket/logging/__init__.py create mode 100644 pytket/pytket/partition/__init__.py create mode 100644 pytket/pytket/passes/__init__.py create mode 100644 pytket/pytket/passes/script.py create mode 100644 pytket/pytket/pauli/__init__.py create mode 100644 pytket/pytket/predicates/__init__.py create mode 100644 pytket/pytket/program/__init__.py create mode 100644 pytket/pytket/py.typed create mode 100644 pytket/pytket/qasm/__init__.py create mode 100644 pytket/pytket/qasm/qasm.py create mode 100644 pytket/pytket/quipper/__init__.py create mode 100644 pytket/pytket/quipper/quipper.py create mode 100644 pytket/pytket/routing/__init__.py create mode 100644 pytket/pytket/tailoring/__init__.py create mode 100644 pytket/pytket/telemetry/__init__.py create mode 100644 pytket/pytket/transform/__init__.py create mode 100644 pytket/pytket/utils/__init__.py create mode 100644 pytket/pytket/utils/expectations.py create mode 100644 pytket/pytket/utils/graph.py create mode 100644 pytket/pytket/utils/measurements.py create mode 100644 pytket/pytket/utils/operators.py create mode 100644 pytket/pytket/utils/outcomearray.py create mode 100644 pytket/pytket/utils/prepare.py create mode 100644 pytket/pytket/utils/results.py create mode 100644 pytket/pytket/utils/serialization/__init__.py create mode 100644 pytket/pytket/utils/spam.py create mode 100644 pytket/pytket/utils/symbolic.py create mode 100644 pytket/pytket/utils/term_sequence.py create mode 100755 pytket/setup.py create mode 100644 pytket/tests/.gitignore create mode 100644 pytket/tests/add_circuit_test.py create mode 100644 pytket/tests/ansatz_sequence_test.py create mode 100644 pytket/tests/assertion_test.py create mode 100644 pytket/tests/backend_test.py create mode 100644 pytket/tests/backendinfo_test.py create mode 100644 pytket/tests/characterisation_test.py create mode 100644 pytket/tests/circuit_test.py create mode 100644 pytket/tests/classical_test.py create mode 100755 pytket/tests/cli-test create mode 100644 pytket/tests/conftest.py create mode 100644 pytket/tests/measurement_setup_test.py create mode 100644 pytket/tests/mitigation_test.py create mode 100644 pytket/tests/passes_script_test.py create mode 100644 pytket/tests/predicates_test.py create mode 100644 pytket/tests/program_test.py create mode 100644 pytket/tests/pytket_config_test.py create mode 100644 pytket/tests/qasm_test.py create mode 100644 pytket/tests/qasm_test_files/test1.qasm create mode 100644 pytket/tests/qasm_test_files/test10.qasm create mode 100644 pytket/tests/qasm_test_files/test11.qasm create mode 100644 pytket/tests/qasm_test_files/test13.qasm create mode 100644 pytket/tests/qasm_test_files/test14.qasm create mode 100644 pytket/tests/qasm_test_files/test15.qasm create mode 100644 pytket/tests/qasm_test_files/test2.qasm create mode 100644 pytket/tests/qasm_test_files/test3.qasm create mode 100644 pytket/tests/qasm_test_files/test4.qasm create mode 100644 pytket/tests/qasm_test_files/test5.qasm create mode 100644 pytket/tests/qasm_test_files/test6.qasm create mode 100644 pytket/tests/qasm_test_files/test7.qasm create mode 100644 pytket/tests/qasm_test_files/test8.qasm create mode 100644 pytket/tests/qasm_test_files/test9.qasm create mode 100644 pytket/tests/qubitpaulioperator_test.py create mode 100755 pytket/tests/quipper_simulate create mode 100644 pytket/tests/quipper_test.py create mode 100644 pytket/tests/quipper_test_files/test1.quip create mode 100644 pytket/tests/quipper_test_files/test2.quip create mode 100644 pytket/tests/quipper_test_files/test3.quip create mode 100644 pytket/tests/quipper_test_files/test4-0.quip create mode 100644 pytket/tests/quipper_test_files/test4-0.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-1.quip create mode 100644 pytket/tests/quipper_test_files/test4-1.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-10.quip create mode 100644 pytket/tests/quipper_test_files/test4-10.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-2.quip create mode 100644 pytket/tests/quipper_test_files/test4-2.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-3.quip create mode 100644 pytket/tests/quipper_test_files/test4-3.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-4.quip create mode 100644 pytket/tests/quipper_test_files/test4-4.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-5.quip create mode 100644 pytket/tests/quipper_test_files/test4-5.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-6.quip create mode 100644 pytket/tests/quipper_test_files/test4-6.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-7.quip create mode 100644 pytket/tests/quipper_test_files/test4-7.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-8.quip create mode 100644 pytket/tests/quipper_test_files/test4-8.quip.simout create mode 100644 pytket/tests/quipper_test_files/test4-9.quip create mode 100644 pytket/tests/quipper_test_files/test4-9.quip.simout create mode 100644 pytket/tests/quipper_test_files/test5.quip create mode 100644 pytket/tests/requirements-openfermion.txt create mode 100644 pytket/tests/requirements.txt create mode 100644 pytket/tests/routing_test.py create mode 100644 pytket/tests/simulator/__init__.py create mode 100644 pytket/tests/simulator/tket_sim_backend.py create mode 100644 pytket/tests/simulator/tket_sim_wrapper.py create mode 100644 pytket/tests/strategies.py create mode 100644 pytket/tests/timing_circuit.py create mode 100644 pytket/tests/tket_sim_test.py create mode 100644 pytket/tests/transform_test.py create mode 100644 pytket/tests/utils_test.py create mode 100755 pytket/tket create mode 100644 recipes/tket-benchmarks/conanfile.py create mode 100644 recipes/tket-coverage/conanfile.py create mode 100644 recipes/tket-proptests/conanfile.py create mode 100644 recipes/tket-proptests/test_package/conanfile.py create mode 100644 recipes/tket-tests/conanfile.py create mode 100644 recipes/tket-tests/test_package/conanfile.py create mode 100644 recipes/tket/conanfile.py create mode 100644 recipes/tket/patches/adjacency_list.diff create mode 100644 recipes/tket/patches/vf2_sub_graph_iso.diff create mode 100644 recipes/tket/test_package/CMakeLists.txt create mode 100644 recipes/tket/test_package/conanfile.py create mode 100644 recipes/tket/test_package/test.cpp create mode 100644 schemas/circuit_v1.json create mode 100644 schemas/compiler_pass_v1.json create mode 100644 schemas/pytket_config_v1.json diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000000..d3ee209b86 --- /dev/null +++ b/.clang-format @@ -0,0 +1,200 @@ +--- +Language: Cpp +# BasedOnStyle: Google +AccessModifierOffset: -1 +AlignAfterOpenBracket: AlwaysBreak +AlignConsecutiveMacros: None +AlignConsecutiveAssignments: None +AlignConsecutiveBitFields: None +AlignConsecutiveDeclarations: None +AlignEscapedNewlines: Left +AlignOperands: Align +AlignTrailingComments: true +AllowAllArgumentsOnNextLine: true +AllowAllConstructorInitializersOnNextLine: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortEnumsOnASingleLine: true +AllowShortBlocksOnASingleLine: Never +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: All +AllowShortLambdasOnASingleLine: All +AllowShortIfStatementsOnASingleLine: WithoutElse +AllowShortLoopsOnASingleLine: true +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: true +AlwaysBreakTemplateDeclarations: Yes +AttributeMacros: + - __capability +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterCaseLabel: false + AfterClass: false + AfterControlStatement: Never + AfterEnum: false + AfterFunction: false + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + AfterExternBlock: false + BeforeCatch: false + BeforeElse: false + BeforeLambdaBody: false + BeforeWhile: false + IndentBraces: false + SplitEmptyFunction: true + SplitEmptyRecord: true + SplitEmptyNamespace: true +BreakBeforeBinaryOperators: None +BreakBeforeConceptDeclarations: true +BreakBeforeBraces: Attach +BreakBeforeInheritanceComma: false +BreakInheritanceList: BeforeColon +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: false +BreakConstructorInitializers: BeforeColon +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: true +ColumnLimit: 80 +CommentPragmas: '^ IWYU pragma:' +CompactNamespaces: false +ConstructorInitializerAllOnOneLineOrOnePerLine: true +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DeriveLineEnding: true +DerivePointerAlignment: true +DisableFormat: false +EmptyLineBeforeAccessModifier: LogicalBlock +ExperimentalAutoDetectBinPacking: false +FixNamespaceComments: true +ForEachMacros: + - foreach + - Q_FOREACH + - BOOST_FOREACH +StatementAttributeLikeMacros: + - Q_EMIT +IncludeBlocks: Regroup +IncludeCategories: + - Regex: '^' + Priority: 2 + SortPriority: 0 + CaseSensitive: false + - Regex: '^<.*\.h>' + Priority: 1 + SortPriority: 0 + CaseSensitive: false + - Regex: '^<.*' + Priority: 2 + SortPriority: 0 + CaseSensitive: false + - Regex: '.*' + Priority: 3 + SortPriority: 0 + CaseSensitive: false +IncludeIsMainRegex: '([-_](test|unittest))?$' +IncludeIsMainSourceRegex: '' +IndentCaseLabels: true +IndentCaseBlocks: false +IndentGotoLabels: true +IndentPPDirectives: None +IndentExternBlock: AfterExternBlock +IndentRequires: false +IndentWidth: 2 +IndentWrappedFunctionNames: false +InsertTrailingCommas: None +JavaScriptQuotes: Leave +JavaScriptWrapImports: true +KeepEmptyLinesAtTheStartOfBlocks: false +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +ObjCBinPackProtocolList: Never +ObjCBlockIndentWidth: 2 +ObjCBreakBeforeNestedBlockParam: true +ObjCSpaceAfterProperty: false +ObjCSpaceBeforeProtocolList: true +PenaltyBreakAssignment: 2 +PenaltyBreakBeforeFirstCallParameter: 1 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyBreakTemplateDeclaration: 10 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 200 +PenaltyIndentedWhitespace: 0 +PointerAlignment: Left +RawStringFormats: + - Language: Cpp + Delimiters: + - cc + - CC + - cpp + - Cpp + - CPP + - 'c++' + - 'C++' + CanonicalDelimiter: '' + BasedOnStyle: google + - Language: TextProto + Delimiters: + - pb + - PB + - proto + - PROTO + EnclosingFunctions: + - EqualsProto + - EquivToProto + - PARSE_PARTIAL_TEXT_PROTO + - PARSE_TEST_PROTO + - PARSE_TEXT_PROTO + - ParseTextOrDie + - ParseTextProtoOrDie + - ParseTestProto + - ParsePartialTestProto + CanonicalDelimiter: '' + BasedOnStyle: google +ReflowComments: true +SortIncludes: true +SortJavaStaticImport: Before +SortUsingDeclarations: true +SpaceAfterCStyleCast: false +SpaceAfterLogicalNot: false +SpaceAfterTemplateKeyword: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeCaseColon: false +SpaceBeforeCpp11BracedList: false +SpaceBeforeCtorInitializerColon: true +SpaceBeforeInheritanceColon: true +SpaceBeforeParens: ControlStatements +SpaceAroundPointerQualifiers: Default +SpaceBeforeRangeBasedForLoopColon: true +SpaceInEmptyBlock: false +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 2 +SpacesInAngles: false +SpacesInConditionalStatement: false +SpacesInContainerLiterals: true +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +SpaceBeforeSquareBrackets: false +BitFieldColonSpacing: Both +Standard: Auto +StatementMacros: + - Q_UNUSED + - QT_REQUIRE_VERSION +TabWidth: 8 +UseCRLF: false +UseTab: Never +WhitespaceSensitiveMacros: + - STRINGIZE + - PP_STRINGIZE + - BOOST_PP_STRINGIZE + - NS_SWIFT_NAME + - CF_SWIFT_NAME +... + diff --git a/.github/workflows/build-docs b/.github/workflows/build-docs new file mode 100755 index 0000000000..1eb5341f76 --- /dev/null +++ b/.github/workflows/build-docs @@ -0,0 +1,32 @@ +#!/bin/bash + +# Copyright 2019-2021 Cambridge Quantum Computing +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +set -u + +cd pytket/docs +rm -rf build +# Capture any unexpected errors or warnings. +# The expected warnings are: +# - "Inline strong start-string without end-string." +# - "Inline emphasis start-string without end-string." +make html 1>out.txt 2>err.txt +cat out.txt err.txt +ERRS=`cat err.txt | grep -v "start-string without end-string"` +if [[ ! -z $ERRS ]] +then + echo "Docs build failed." + exit 1 +fi diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml new file mode 100644 index 0000000000..4639c4174d --- /dev/null +++ b/.github/workflows/build_and_test.yml @@ -0,0 +1,374 @@ +name: Build and test + +on: + pull_request: + branches: + - master + - develop + push: + branches: + - develop + schedule: + # 03:00 every Saturday morning + - cron: '0 3 * * 6' + +jobs: + + linux: + name: Build and test (Linux) + runs-on: ubuntu-20.04 + env: + CC: gcc-10 + CXX: g++-10 + PYTKET_SKIP_REGISTRATION: "true" + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Get current time + uses: srfrnk/current-time@v1.1.0 + id: current_time + with: + format: YYYYMMDDHHmmss + - name: Cache ccache data + uses: actions/cache@v2 + with: + path: ~/.ccache + key: ${{ runner.os }}-tket-ccache-${{ steps.current_time.outputs.formattedTime }} + restore-keys: | + ${{ runner.os }}-tket-ccache- + - name: apt update + run: sudo apt update + - name: Check doxygen + if: github.event_name == 'pull_request' + run: | + sudo apt install -y doxygen graphviz + cd bubble && doxygen + - name: Install conan + id: conan + # urllib3 because of TKET-865 (remove when conan fixes its dependencies) + run: | + pip install urllib3==1.25.11 conan + conan_cmd=/home/runner/.local/bin/conan + ${conan_cmd} profile new tket --detect + ${conan_cmd} profile update settings.compiler.libcxx=libstdc++11 tket + ${conan_cmd} config set general.revisions_enabled=1 + echo "CONAN_CMD=${conan_cmd}" >> $GITHUB_ENV + - name: Install ninja and ccache + run: sudo apt-get install ninja-build ccache + - name: Build tket + run: ${CONAN_CMD} create --profile=tket --build=missing recipes/tket + - name: Install runtime test requirements + run: | + sudo apt-get install texlive texlive-latex-extra latexmk + mkdir -p ~/texmf/tex/latex + wget http://mirrors.ctan.org/graphics/pgf/contrib/quantikz/tikzlibraryquantikz.code.tex -P ~/texmf/tex/latex + - name: Build and run tket tests + run: ${CONAN_CMD} create --profile=tket recipes/tket-tests + - name: Build and run tket proptests + run: ${CONAN_CMD} create --profile=tket recipes/tket-proptests + - name: Set up Python 3.7 + if: github.event_name == 'push' + uses: actions/setup-python@v2 + with: + python-version: 3.7 + - name: Build pytket (3.7) + if: github.event_name == 'push' + run: | + cd pytket + pip install -e . -v + - name: Test pytket (3.7) + if: github.event_name == 'push' + run: | + cd pytket/tests + pip install -r requirements.txt + pip install -r requirements-openfermion.txt + pytest --ignore=simulator/ --doctest-modules + - name: Set up Python 3.8 + if: github.event_name == 'pull_request' + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Build pytket (3.8) + if: github.event_name == 'pull_request' + run: | + cd pytket + pip install -e . -v + - name: Test building docs + if: github.event_name == 'pull_request' + timeout-minutes: 20 + run: | + pip install -r pytket/docs/requirements.txt + ./.github/workflows/build-docs + - name: Test pytket (3.8) + if: github.event_name == 'pull_request' + run: | + cd pytket/tests + pip install -r requirements.txt + pip install -r requirements-openfermion.txt + pytest --ignore=simulator/ --doctest-modules + - name: Set up Python 3.9 + if: github.event_name == 'schedule' + uses: actions/setup-python@v2 + with: + python-version: 3.9 + - name: Build pytket (3.9) + if: github.event_name == 'schedule' + run: | + cd pytket + pip install -e . -v + - name: Test pytket (3.9) + if: github.event_name == 'schedule' + run: | + cd pytket/tests + pip install -r requirements.txt + pip install -r requirements-openfermion.txt + pytest --ignore=simulator/ --doctest-modules + + macos: + name: Build and test (MacOS) + runs-on: macos-10.15 + env: + PYTKET_SKIP_REGISTRATION: "true" + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Check C++ code formatting + if: github.event_name == 'pull_request' + run: | + brew install clang-format + git ls-files "*.cpp" "*.hpp" | xargs clang-format -style=file --dry-run --Werror + - name: Set up Python 3.9 + uses: actions/setup-python@v2 + with: + python-version: 3.9 + - name: Install conan + id: conan + # urllib3 because of TKET-865 (remove when conan fixes its dependencies) + run: | + pip install urllib3==1.25.11 conan + conan profile new tket --detect --force + conan config set general.revisions_enabled=1 + export CC=`which conan` + echo "CONAN_CMD=${CC}" >> $GITHUB_ENV + - name: Build tket + run: conan create --profile=tket recipes/tket + - name: Build and run tket tests + run: conan create --profile=tket recipes/tket-tests + - name: Build and run tket proptests + run: conan create --profile=tket recipes/tket-proptests + - name: Set up Python 3.7 + if: github.event_name == 'push' + uses: actions/setup-python@v2 + with: + python-version: 3.7 + - name: Build pytket (3.7) + if: github.event_name == 'push' + run: | + cd pytket + pip install -e . -v + - name: Test pytket (3.7) + if: github.event_name == 'push' + run: | + cd pytket/tests + pip install -r requirements.txt + pip install -r requirements-openfermion.txt + pytest --ignore=simulator/ --doctest-modules + - name: Set up Python 3.8 + if: github.event_name == 'pull_request' + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Build pytket (3.8) + if: github.event_name == 'pull_request' + run: | + cd pytket + pip install -e . -v + - name: Test pytket (3.8) + if: github.event_name == 'pull_request' + run: | + cd pytket/tests + pip install -r requirements.txt + pip install -r requirements-openfermion.txt + pytest --ignore=simulator/ --doctest-modules + - name: Run mypy + if: github.event_name == 'pull_request' + run: | + pip install -U mypy + cd pytket + mypy --config-file=mypy.ini --no-incremental -p pytket -p tests + - name: Set up Python 3.9 + if: github.event_name == 'schedule' + uses: actions/setup-python@v2 + with: + python-version: 3.9 + - name: Build pytket (3.9) + if: github.event_name == 'schedule' + run: | + cd pytket + pip install -e . -v + - name: Test pytket (3.9) + if: github.event_name == 'schedule' + run: | + cd pytket/tests + pip install -r requirements.txt + pip install -r requirements-openfermion.txt + pytest --ignore=simulator/ --doctest-modules + + macos-m1: + name: Build and test (MacOS M1) + runs-on: [self-hosted, macos, M1] + if: github.event_name == 'push' || github.event_name == 'schedule' || github.event.pull_request.head.repo.full_name == github.repository + defaults: + run: + shell: "/usr/bin/arch -arch arm64e /bin/bash {0}" + env: + PYTKET_SKIP_REGISTRATION: "true" + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Set up conan + id: conan + run: | + conan profile new tket --detect --force + conan config set general.revisions_enabled=1 + export CC=`which conan` + echo "CONAN_CMD=${CC}" >> $GITHUB_ENV + - name: Install boost + run: conan install --profile=tket boost/1.77.0@ --build=missing -o boost:without_fiber=True -o boost:without_json=True -o boost:without_nowide=True + - name: Build tket + run: conan create --profile=tket recipes/tket -o boost:without_fiber=True -o boost:without_json=True -o boost:without_nowide=True + - name: Build and run tket tests + run: conan create --profile=tket recipes/tket-tests -o boost:without_fiber=True -o boost:without_json=True -o boost:without_nowide=True + - name: Build and run tket proptests + run: conan create --profile=tket recipes/tket-proptests -o boost:without_fiber=True -o boost:without_json=True -o boost:without_nowide=True + - name: Build pytket (3.8) + if: github.event_name == 'pull_request' || github.event_name == 'push' + run: | + eval "$(pyenv init -)" + pyenv shell tket-3.8 + OPENBLAS="$(brew --prefix openblas)" pip install -U scipy + cd pytket + pip install -e . -v + - name: Test pytket (3.8) + if: github.event_name == 'pull_request' || github.event_name == 'push' + run: | + eval "$(pyenv init -)" + pyenv shell tket-3.8 + cd pytket/tests + pip install -r requirements.txt + pytest --ignore=simulator/ --doctest-modules + - name: Build pytket (3.9) + if: github.event_name == 'schedule' + run: | + eval "$(pyenv init -)" + pyenv shell tket-3.9 + OPENBLAS="$(brew --prefix openblas)" pip install -U scipy + cd pytket + pip install -e . -v + - name: Test pytket (3.9) + if: github.event_name == 'schedule' + run: | + eval "$(pyenv init -)" + pyenv shell tket-3.9 + cd pytket/tests + pip install -r requirements.txt + pytest --ignore=simulator/ --doctest-modules + + windows: + name: Build and test (Windows) + runs-on: windows-2019 + env: + PYTKET_SKIP_REGISTRATION: "true" + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - name: Hash bubble source + id: hash_bubble_source + run: | + Function Get-FolderHash + { + param ($folder) + $files = dir $folder -Recurse |? { -not $_.psiscontainer } + $allBytes = new-object System.Collections.Generic.List[byte] + foreach ($file in $files) + { + $allBytes.AddRange([System.IO.File]::ReadAllBytes($file.FullName)) + $allBytes.AddRange([System.Text.Encoding]::UTF8.GetBytes($file.Name)) + } + $hasher = [System.Security.Cryptography.MD5]::Create() + $ret = [string]::Join("",$($hasher.ComputeHash($allBytes.ToArray()) | %{"{0:x2}" -f $_})) + return $ret + } + $bubble_hash = Get-FolderHash bubble + echo "::set-output name=bubble_hash::${bubble_hash}" + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Install conan + # urllib3 because of TKET-865 (remove when conan fixes its dependencies) + run: | + pip install urllib3==1.25.11 conan + conan profile new tket --detect + conan config set general.revisions_enabled=1 + $conan_cmd = (gcm conan).Path + echo "CONAN_CMD=${conan_cmd}" >> $GITHUB_ENV + - name: Cache bubble build + id: cache-bubble + uses: actions/cache@v2 + with: + path: C:\Users\runneradmin\.conan\data\tket + key: ${{ runner.os }}-tket-bubble-${{ steps.hash_bubble_source.outputs.bubble_hash }}-11 + - name: Build tket + if: steps.cache-bubble.outputs.cache-hit != 'true' + run: conan create --profile=tket recipes/tket + - name: Build and run tket tests + run: conan create --profile=tket recipes/tket-tests + - name: Build and run tket proptests + run: conan create --profile=tket recipes/tket-proptests + - name: Set up Python 3.7 + if: github.event_name == 'push' + uses: actions/setup-python@v2 + with: + python-version: 3.7 + - name: Build and test pytket (3.7) + if: github.event_name == 'push' + run: | + cd pytket + pip install -e . -v + cd tests + pip install -r requirements.txt + pip install -r requirements-openfermion.txt + pytest --ignore=simulator/ --doctest-modules + - name: Set up Python 3.8 + if: github.event_name == 'pull_request' + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Build and test pytket (3.8) + if: github.event_name == 'pull_request' + run: | + cd pytket + pip install -e . -v + cd tests + pip install -r requirements.txt + pip install -r requirements-openfermion.txt + pytest --ignore=simulator/ --doctest-modules + - name: Set up Python 3.9 + if: github.event_name == 'schedule' + uses: actions/setup-python@v2 + with: + python-version: 3.9 + - name: Build and test pytket (3.9) + if: github.event_name == 'schedule' + run: | + cd pytket + pip install -e . -v + cd tests + pip install -r requirements.txt + pip install -r requirements-openfermion.txt + pytest --ignore=simulator/ --doctest-modules diff --git a/.github/workflows/build_macos_m1_wheel b/.github/workflows/build_macos_m1_wheel new file mode 100755 index 0000000000..f5fefb3294 --- /dev/null +++ b/.github/workflows/build_macos_m1_wheel @@ -0,0 +1,23 @@ +#!/bin/bash + +# Copyright 2019-2021 Cambridge Quantum Computing +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +set -evu + +pip install conan delocate wheel +cd $GITHUB_WORKSPACE/pytket +export PYVER=`python -c 'import sys; print(".".join(map(str, sys.version_info[:3])))'` +python setup.py bdist_wheel -d "$GITHUB_WORKSPACE/tmp/tmpwheel_${PYVER}" +delocate-wheel -v -w "$GITHUB_WORKSPACE/wheelhouse/${PYVER}/" "$GITHUB_WORKSPACE/tmp/tmpwheel_${PYVER}/pytket-"*".whl" diff --git a/.github/workflows/build_macos_wheel b/.github/workflows/build_macos_wheel new file mode 100755 index 0000000000..8be80edbea --- /dev/null +++ b/.github/workflows/build_macos_wheel @@ -0,0 +1,24 @@ +#!/bin/bash + +# Copyright 2019-2021 Cambridge Quantum Computing +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +set -evu + +# urllib3 because of TKET-865 (remove when conan fixes its dependencies) +pip install urllib3==1.25.11 conan delocate wheel +cd $GITHUB_WORKSPACE/pytket +export PYVER=`python -c 'import sys; print(".".join(map(str, sys.version_info[:3])))'` +python setup.py bdist_wheel -d "$GITHUB_WORKSPACE/tmp/tmpwheel_${PYVER}" --plat-name=macosx_10_14_x86_64 +delocate-wheel -v -w "$GITHUB_WORKSPACE/wheelhouse/${PYVER}/" "$GITHUB_WORKSPACE/tmp/tmpwheel_${PYVER}/pytket-"*".whl" diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000000..091d297fb0 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,34 @@ +name: Deploy development documentation + +on: + push: + branches: + - develop + paths: + - 'bubble/src/**' + +jobs: + bubble_docs: + + runs-on: ubuntu-20.04 + + steps: + - uses: actions/checkout@v2 + + - name: Install Doxygen + run: sudo apt update && sudo apt install -y doxygen graphviz + + - name: Build Doxygen docs + run: cd bubble && doxygen + + # TODO Deploy somewhere public. + # E.g. https://github.com/peaceiris/actions-gh-pages + # - name: Login via Azure CLI + # uses: azure/login@v1 + # with: + # creds: ${{ secrets.AZURE_CREDENTIALS }} + + # - uses: azure/webapps-deploy@v2 + # with: + # app-name: 'BubbleDoxygen' + # package: './bubble/doc/html/' diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000000..49ee53c9a5 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,25 @@ +name: Lint python projects + +on: [push] + +jobs: + lint: + + runs-on: ubuntu-20.04 + + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.x + uses: actions/setup-python@v2 + with: + python-version: '3.x' + - name: Install black and pylint + run: pip install black~=21.6b0 pylint + - name: Check files are formatted with black + run: | + # Paths specified to avoid formatting submodules + black --check . + - name: pylint check + run: | + cd pytket + pylint pytket/ diff --git a/.github/workflows/linuxbuildwheel b/.github/workflows/linuxbuildwheel new file mode 100755 index 0000000000..21954df18c --- /dev/null +++ b/.github/workflows/linuxbuildwheel @@ -0,0 +1,44 @@ +#!/bin/bash + +# Copyright 2019-2021 Cambridge Quantum Computing +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +set -evu + +# Choose a Python to install conan +export PYBIN=/opt/python/cp39-cp39/bin + +# urllib3 because of TKET-865 (remove when conan fixes its dependencies) +${PYBIN}/pip install urllib3==1.25.11 conan + +export CONAN_CMD=${PYBIN}/conan + +cd /tket + +${CONAN_CMD} profile new tket --detect +${CONAN_CMD} config set general.revisions_enabled=1 +${CONAN_CMD} create --profile=tket --test-folder=None recipes/tket + +cd /tket/pytket +mkdir wheelhouse +mkdir audited + +for pyX in $PY_VERS +do + cd /tket/pytket + export PYEX=/opt/python/${pyX}/bin/python + export PYVER=`${PYEX} -c 'import sys; print(".".join(map(str, sys.version_info[:3])))'` + ${PYEX} setup.py bdist_wheel -d "tmpwheel_${PYVER}" + auditwheel repair "tmpwheel_${PYVER}/pytket-"*".whl" -w "audited/${PYVER}/" +done diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml new file mode 100644 index 0000000000..bd768f7df7 --- /dev/null +++ b/.github/workflows/nightly.yml @@ -0,0 +1,79 @@ +name: nightly test-coverage + +on: + schedule: + # 03:00 every Saturday morning + - cron: '0 4 * * 6' + +jobs: + + linux: + name: Execute coverage test (Linux) + runs-on: ubuntu-20.04 + env: + PYTKET_SKIP_REGISTRATION: "true" + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Get current time + uses: srfrnk/current-time@v1.1.0 + id: current_time + with: + format: YYYYMMDDHHmmss + - name: Cache ccache data + uses: actions/cache@v2 + with: + path: ~/.ccache + key: ${{ runner.os }}-tket-ccache-${{ steps.current_time.outputs.formattedTime }} + restore-keys: | + ${{ runner.os }}-tket-ccache- + - name: Install conan + id: conan + # urllib3 because of TKET-865 (remove when conan fixes its dependencies) + # install gcovr package for coverage test + # conan profile: change to debug mode + run: | + pip install urllib3==1.25.11 conan + conan_cmd=/home/runner/.local/bin/conan + ${conan_cmd} profile new tket --detect + ${conan_cmd} profile update settings.compiler.libcxx=libstdc++11 tket + ${conan_cmd} profile update settings.build_type=Debug tket + echo "CONAN_CMD=${conan_cmd}" >> $GITHUB_ENV + pip install gcovr + - name: Install ninja and ccache + run: | + sudo apt-get update + sudo apt-get install ninja-build ccache gcovr + - name: Build tket + run: ${CONAN_CMD} create --profile=tket recipes/tket + - name: Install runtime test requirements + run: | + sudo apt-get install texlive texlive-latex-extra latexmk + mkdir -p ~/texmf/tex/latex + wget http://mirrors.ctan.org/graphics/pgf/contrib/quantikz/tikzlibraryquantikz.code.tex -P ~/texmf/tex/latex + - name: Install gcovr + run: pip install gcovr + - name: Build tket-coverage + run: ${CONAN_CMD} create --profile=tket recipes/tket-coverage + # TODO Deploy somewhere public. + # E.g. https://github.com/peaceiris/actions-gh-pages + # - name: Login via Azure CLI + # uses: azure/login@v1 + # with: + # creds: ${{ secrets.AZURE_CREDENTIALS }} + # - name: find directory for html files + # run: | + # cd /home/runner/.conan/data/tket-coverage + # cd * + # cd _/_/build + # cd * + # cd coverage + # coverage_html=$(pwd) + # echo "COVERAGE_HTML=${coverage_html}/" >> $GITHUB_ENV + # echo $COVERAGE_HTML + # - uses: azure/webapps-deploy@v2 + # with: + # app-name: 'BubbleCoverage' + # package: ${{ env.COVERAGE_HTML }} diff --git a/.github/workflows/pytket_docs.yml b/.github/workflows/pytket_docs.yml new file mode 100644 index 0000000000..a68ab989d4 --- /dev/null +++ b/.github/workflows/pytket_docs.yml @@ -0,0 +1,80 @@ +name: Pytket Docs + +on: + push: + branches: + - 'docs/**' + +jobs: + docs: + name: build docs + runs-on: ubuntu-20.04 + env: + PYTKET_SKIP_REGISTRATION: "true" + strategy: + matrix: + python-version: [3.8] + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Get current time + uses: srfrnk/current-time@v1.1.0 + id: current_time + with: + format: YYYYMMDDHHmmss + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Cache ccache data + uses: actions/cache@v2 + with: + path: ~/.ccache + key: ${{ runner.os }}-tket-ccache-${{ steps.current_time.outputs.formattedTime }} + restore-keys: | + ${{ runner.os }}-tket-ccache- + - name: Get pip cache + id: pip-cache + run: | + python -c "from pip._internal.locations import USER_CACHE_DIR; print('::set-output name=dir::' + USER_CACHE_DIR)" + - name: Cache pip + uses: actions/cache@v2 + with: + path: ${{ steps.pip-cache.outputs.dir }} + # Look to see if there is a cache hit for the corresponding requirements file + key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('pytket/**/requirements*.txt') }} + restore-keys: | + ${{ runner.os }}-pip-${{ matrix.python-version }}- + ${{ runner.os }}-pip- + - name: Install prerequisites + run: | + sudo apt-get update + sudo apt-get install ninja-build ccache graphviz + - name: Install conan + # urllib3 because of TKET-865 (remove when conan fixes its dependencies) + run: | + pip install urllib3==1.25.11 conan + conan profile new tket --detect + conan profile update settings.compiler.libcxx=libstdc++11 tket + conan config set general.revisions_enabled=1 + - name: Build tket + run: conan create --profile=tket recipes/tket + - name: Build pytket + run: | + cd pytket + pip install -e . -v + - name: Install docs dependencies + run: | + pip install -r pytket/docs/requirements.txt + - name: Test building docs + timeout-minutes: 20 + run: | + ./.github/workflows/build-docs + - name: Upload docs + if: github.event_name == 'push' + uses: actions/upload-artifact@v2 + with: + name: pytket-docs + path: pytket/docs/build/html/ diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000000..58bbd7598e --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,317 @@ +name: Release + +on: + release: + types: + - created + - edited + push: + branches: + - 'wheel/**' + +jobs: + build_Linux_wheels: + name: Build manylinux + runs-on: ubuntu-20.04 + env: + PY_VERS: cp37-cp37m cp38-cp38 cp39-cp39 + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Set up container + run: | + docker create --name linux_build -i -v /:/host quay.io/pypa/manylinux2014_x86_64:latest /bin/bash + docker cp . linux_build:/tket/ + - name: Run build + run: | + docker start linux_build + docker exec -e PY_VERS="${PY_VERS}" linux_build /bin/bash -c "/tket/.github/workflows/linuxbuildwheel" + mkdir wheelhouse + docker cp linux_build:/tket/pytket/audited/. wheelhouse/ + docker rm --force -v linux_build + - uses: actions/upload-artifact@v2 + with: + name: Linux_wheels + path: wheelhouse/ + + build_macos_wheels: + name: Build macos wheels + runs-on: macos-10.15 + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Set up Python 3.7 + uses: actions/setup-python@v2 + with: + python-version: 3.7 + - name: Build bubble + # urllib3 because of TKET-865 (remove when conan fixes its dependencies) + run: | + pip install urllib3==1.25.11 conan + conan profile new tket --detect --force + conan config set general.revisions_enabled=1 + conan create --profile=tket --build=missing recipes/tket + - name: Build wheel (3.7) + run: .github/workflows/build_macos_wheel + - name: Set up Python 3.8 + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Build wheel (3.8) + run: .github/workflows/build_macos_wheel + - name: Set up Python 3.9 + uses: actions/setup-python@v2 + with: + python-version: 3.9 + - name: Build wheel (3.9) + run: .github/workflows/build_macos_wheel + - uses: actions/upload-artifact@v2 + with: + name: MacOS_wheels + path: wheelhouse/ + + build_macos_M1_wheels: + name: Build macos (M1) wheels + runs-on: [self-hosted, macos, M1] + defaults: + run: + shell: "/usr/bin/arch -arch arm64e /bin/bash {0}" + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Build wheels + run: | + eval "$(pyenv init -)" + pyenv shell tket-3.8 + conan profile new tket --detect --force + conan config set general.revisions_enabled=1 + conan install --profile=tket boost/1.77.0@ --build=missing -o boost:without_fiber=True -o boost:without_json=True -o boost:without_nowide=True + conan create --profile=tket recipes/tket -o boost:without_fiber=True -o boost:without_json=True -o boost:without_nowide=True + .github/workflows/build_macos_m1_wheel + pyenv shell tket-3.9 + .github/workflows/build_macos_m1_wheel + - uses: actions/upload-artifact@v2 + with: + name: MacOS_M1_wheels + path: wheelhouse/ + + build_Windows_wheels: + name: Build Windows wheels + runs-on: windows-2019 + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: '0' + - name: Hash bubble source + id: hash_bubble_source + run: | + Function Get-FolderHash + { + param ($folder) + $files = dir $folder -Recurse |? { -not $_.psiscontainer } + $allBytes = new-object System.Collections.Generic.List[byte] + foreach ($file in $files) + { + $allBytes.AddRange([System.IO.File]::ReadAllBytes($file.FullName)) + $allBytes.AddRange([System.Text.Encoding]::UTF8.GetBytes($file.Name)) + } + $hasher = [System.Security.Cryptography.MD5]::Create() + $ret = [string]::Join("",$($hasher.ComputeHash($allBytes.ToArray()) | %{"{0:x2}" -f $_})) + return $ret + } + $bubble_hash = Get-FolderHash bubble + echo "::set-output name=bubble_hash::${bubble_hash}" + - run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* + - name: Install conan + # urllib3 because of TKET-865 (remove when conan fixes its dependencies) + run: | + pip install urllib3==1.25.11 conan + conan profile new tket --detect + conan config set general.revisions_enabled=1 + $conan_cmd = (gcm conan).Path + echo "CONAN_CMD=${conan_cmd}" >> $GITHUB_ENV + - name: Cache bubble build + id: cache-bubble + uses: actions/cache@v2 + with: + path: C:\Users\runneradmin\.conan\data\tket + key: ${{ runner.os }}-tket-bubble-${{ steps.hash_bubble_source.outputs.bubble_hash }}-5 + - name: Build tket + if: steps.cache-bubble.outputs.cache-hit != 'true' + run: | + conan create --profile=tket recipes/tket + - name: Set up Python 3.7 + uses: actions/setup-python@v2 + with: + python-version: 3.7 + - name: Build wheel (3.7) + run: | + pip install wheel + cd pytket + python setup.py bdist_wheel -d "${{ github.workspace }}/wheelhouse/3.7" + - uses: actions/upload-artifact@v2 + with: + name: Windows_wheels + path: wheelhouse/ + - name: Set up Python 3.8 + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Build wheel (3.8) + run: | + pip install wheel + cd pytket + python setup.py bdist_wheel -d "${{ github.workspace }}/wheelhouse/3.8" + - uses: actions/upload-artifact@v2 + with: + name: Windows_wheels + path: wheelhouse/ + - name: Set up Python 3.9 + uses: actions/setup-python@v2 + with: + python-version: 3.9 + - name: Build wheel (3.9) + run: | + pip install wheel + cd pytket + python setup.py bdist_wheel -d "${{ github.workspace }}/wheelhouse/3.9" + - uses: actions/upload-artifact@v2 + with: + name: Windows_wheels + path: wheelhouse/ + + test_linux_wheels: + name: Test linux wheels + needs: build_Linux_wheels + runs-on: ubuntu-20.04 + env: + PYTKET_SKIP_REGISTRATION: "true" + strategy: + matrix: + python-version: [3.7, 3.8, 3.9] + steps: + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Download wheels + uses: actions/download-artifact@v1 + with: + name: Linux_wheels + path: wheelhouse/ + - name: Install wheel + run: pip install wheelhouse/${{ matrix.python-version }}.*/pytket-*.whl + - uses: actions/checkout@v2 + with: + path: tket + - name: Setup tests + run: | + cd tket/pytket/tests + pip install -r requirements.txt + - name: Run tests + run: cd tket/pytket/tests && pytest --ignore=simulator/ --doctest-modules + + test_macos_wheels: + name: Test macos wheels + needs: build_macos_wheels + runs-on: macos-10.15 + env: + PYTKET_SKIP_REGISTRATION: "true" + strategy: + matrix: + python-version: [3.7, 3.8, 3.9] + steps: + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Download wheels + uses: actions/download-artifact@v1 + with: + name: MacOS_wheels + path: wheelhouse/ + - uses: actions/checkout@v2 + with: + path: tket + - name: Install wheel + run: | + pip install $GITHUB_WORKSPACE/wheelhouse/${{ matrix.python-version }}.*/pytket-*.whl + - name: Run tests + run: | + cd tket/pytket/tests + pip install -r requirements.txt + pytest --ignore=simulator/ --doctest-modules + + test_macos_M1_wheels: + name: Test macos wheels + needs: build_macos_M1_wheels + runs-on: [self-hosted, macos, M1] + defaults: + run: + shell: "/usr/bin/arch -arch arm64e /bin/bash {0}" + env: + PRIVATE_PYPI_PASS: ${{ secrets.PRIVATE_PYPI_PASS }} + PYTKET_SKIP_REGISTRATION: "true" + strategy: + matrix: + python-version: [3.8, 3.9] + steps: + - name: Download wheels + uses: actions/download-artifact@v1 + with: + name: MacOS_M1_wheels + path: wheelhouse/ + - uses: actions/checkout@v2 + with: + path: tket + - name: Install wheel + run: | + eval "$(pyenv init -)" + pyenv shell tket-${{ matrix.python-version }} + pip uninstall -y pytket + pip install $GITHUB_WORKSPACE/wheelhouse/${{ matrix.python-version }}.*/pytket-*.whl + - name: Run tests + run: | + eval "$(pyenv init -)" + pyenv shell tket-${{ matrix.python-version }} + cd pytket/tests + pip install -r requirements.txt + pytest --ignore=simulator/ --doctest-modules + + test_Windows_wheels: + name: Test Windows wheels + needs: build_Windows_wheels + runs-on: windows-2019 + env: + PYTKET_SKIP_REGISTRATION: "true" + strategy: + matrix: + python-version: [3.7, 3.8, 3.9] + steps: + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Download wheels + uses: actions/download-artifact@v1 + with: + name: Windows_wheels + path: wheelhouse/ + - name: Install wheel + shell: bash + run: for i in wheelhouse/${{ matrix.python-version }}/pytket-*.whl ; do pip install $i ; done + - uses: actions/checkout@v2 + with: + path: tket + - name: Run tests + run: | + pip install pytest hypothesis + cd tket/pytket/tests + pip install -r requirements.txt + pytest --ignore=simulator/ --doctest-modules diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..a0fd5b8672 --- /dev/null +++ b/.gitignore @@ -0,0 +1,23 @@ +*.dll +*.dot +*.dylib +*.egg-info +*.o +*.so +.cache +.eggs +.hypothesis +.ipynb_checkpoints +.mypy_cache +CMakeCache.txt +CMakeFiles +__pycache__ +build +depgraph.png +dist +doc +pytket/tests/qasm_test_files/testout.qasm +pytket/tests/qasm_test_files/testout2.qasm +pytket/tests/qasm_test_files/testout3.qasm +pytket/tests/qasm_test_files/testout4.qasm +pytket/tests/qasm_test_files/testout5.qasm diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000000..c6f42ca981 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,18 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +repos: + - repo: https://github.com/psf/black + rev: 19.10b0 + hooks: + - id: black + language_version: python36 + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.4.0 + hooks: + # - id: trailing-whitespace + # - id: end-of-file-fixer + - id: check-yaml + - id: check-added-large-files + +default_language_version: + python: python36 diff --git a/README.md b/README.md new file mode 100644 index 0000000000..3ffd00a70f --- /dev/null +++ b/README.md @@ -0,0 +1,245 @@ +# tket + +## Introduction + +This repository contains the full source code for tket, a quantum SDK. + +If you just want to use tket via Python, the easiest way is to install it with +`pip`: + +```shell +pip install pytket + +``` + +For full API documentation, as well as a comprehensive user manual and a +selection of example notebooks, please follow the links from the +[pytket](https://github.com/CQCL/pytket) main page. + +Note that the various pytket extensions (which allow pytket to interface with +other software packages and with quantum devices) live in the separate +[pytket-extensions](https://github.com/CQCL/pytket-extensions) repository. + +If you would like to build tket yourself and help to improve it, read on! + +The core functionality of tket is implemented in C++. The source for this +resides in the `bubble` directory. + +The source code for pytket (which includes the abstract `Backend` interface used +by the extension modules) resides in the `pytket` directory. This consists of +binder modules (written in C++ and making use of `pybind11` to link to the tket +shared library) and pure Python code for the `Backend` interface and various +utilities. + +## How to build tket and pytket + +### Prerequisites + +#### Build tools + +The following compiler toolchains are used to build tket on the CI and are +therefore known to work: + +* Linux: gcc-10 +* MacOS: apple-clang 12 +* Windows: MSVC 19 + +It is recommended that you use these versions to build locally, as code may +depend on the features they support. The compiler version can be controlled by +setting `CC` and `CXX` in your environment (e.g. `CC=gcc-10` and `CXX=g++-10`), +or on Debian-based Linux systems using `update-alternatives`. + +You should also have Python (3.7, 3.8 or 3.9) and `pip` installed. We use +`cmake` and the package manager `conan` to build tket. Both can be installed +with `pip`: + +```shell +pip install cmake conan +``` + +It is recommended that you also install `ninja` and `ccache` to speed up the +build process. For example on Debian/Ubuntu: + +```shell +sudo apt install ninja-build ccache +``` + +#### Set up `conan` profile + +Generate a profile that matches your current machine. This profile does not have +to be called `tket`, but if you give it another name you will have to set +`CONAN_TKET_PROFILE` to its name in your environment when you build the Python +module. + +```shell +conan profile new tket --detect +``` + +If this prints a warning about `gcc` ABI compatibility (as it probably will on +Linux), adjust the profile compiler settings with the following command, as +recommended in the warning message: + +```shell +conan profile update settings.compiler.libcxx=libstdc++11 tket +``` + +If you wish you can set your profile to Debug mode: + +```shell +conan profile update settings.build_type=Debug tket +``` + +#### Enable revisions + +In order to pick up the proper revision of the `pybind11` package, it is +currently necessary to do the following (or equivalent): + +```shell +conan config set general.revisions_enabled=1 +``` + +#### Test dependencies + +A few of the bubble tests require a working LaTeX installation, including +`latexmk` and the `quantikz` package. By default these are only run on Linux. +Passing `~[latex]` to the test executable will disable them. To install the +Latex dependencies on (Debian flavours of) Linux you can do: + +```shell +sudo apt-get install texlive texlive-latex-extra latexmk +mkdir -p ~/texmf/tex/latex +wget http://mirrors.ctan.org/graphics/pgf/contrib/quantikz/tikzlibraryquantikz.code.tex -P ~/texmf/tex/latex + +``` + +The Python tests require a few more packages. These can be installed with: + +```shell +pip install -r pytket/tests/requirements.txt +``` +### Building tket + +#### Method 1 + +At this point you can run: + +```shell +conan create --profile=tket recipes/tket +``` + +to build the tket library. + +To build and run the bubble tests: + +```shell +conan create --profile=tket recipes/tket-tests +``` + +If you want to build them without running them, pass `--test-folder None` to the +`conan` command. (You can still run them manually afterwards.) + +There is also a small set of property-based tests which you can build and run +with: + +```shell +conan create --profile=tket recipes/tket-proptests +``` + +Now to build pytket: + +```shell +cd pytket +pip install -e . +``` + +And then to run the Python tests: + +```shell +cd tests +pytest +``` + +#### Method 2 + +In a development cycle, it may save time to break down the `conan create` +command from above into separate build and export commands. + +First create a `build` folder in the project root. Then proceed as follows. + +1. To install dependencies: + + ```shell + conan install recipes/tket --install-folder=build --profile=tket --build=missing + ``` +2. To configure the build: + + ```shell + conan build recipes/tket --configure --build-folder=build --source-folder=bubble/src + ``` +3. To build: + + ```shell + conan build recipes/tket --build --build-folder=build + ``` +4. To export to `conan` cache (necessary to build pytket): + + ```shell + conan export-pkg recipes/tket -f --build-folder=build --source-folder=bubble/src + ``` + +## Contributing + +Pull requests are welcome. To make a PR, first fork the repo, make your proposed +changes on the `develop` branch, and open a PR from your fork. If it passes +tests and is accepted after review, it will be merged in. + +When adding a new feature, please add tests for it. When fixing a bug, please +add a test that demonstrates the fix. + +### Code style + +#### C++ + +C++20 features may be used whenever they are supported by all the compilers +listed above. + +All C++ code should be formatted with `clang-format` (v12) using the +configuration file `.clang-format` in the root directory. This is checked on +the CI. The script `do-clang-format` will run this over all C++ files in the +repository and fix them up. + +You can mark sections of code with `// clang-format off` and +`// clang-format on` to tell the tool to skip them, e.g. when it is helpful to +have data laid out in a certain way. + +In other matters of style, please try to follow the +[Google style guide](https://google.github.io/styleguide/cppguide.html). + +Declarations in header files should have Doxygen-style documentation, +sufficient to make it clear what each object and method is and does. + +#### Python + +##### Formatting + +All Python code should be formatted using +[black](https://black.readthedocs.io/en/stable/), with default options. This is +checked on the CI. + +##### Type annotation + +On the CI, [mypy](https://mypy.readthedocs.io/en/stable/) is used as a static +type checker and all submissions must pass its checks. You should therefore run +`mypy` locally on any changed files before submitting a PR. The following +command will perform all required checks: + +```shell +cd pytket +mypy --config-file=mypy.ini -p pytket -p tests +``` + +##### Linting + +We use [pylint](https://pypi.org/project/pylint/) on the CI to check compliance +with a set of style requirements (listed in `pytket/.pylintrc`). You should run +`pylint` over any changed files before submitting a PR, to catch any issues. diff --git a/bubble/Doxyfile b/bubble/Doxyfile new file mode 100644 index 0000000000..0ca560ec8d --- /dev/null +++ b/bubble/Doxyfile @@ -0,0 +1,2576 @@ +# Doxyfile 1.8.17 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "bubble" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) ands Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = YES + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ./src + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = *_main.cpp + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files +# were built. This is equivalent to specifying the "-p" option to a clang tool, +# such as clang-check. These options will then be passed to the parser. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = YES + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_CHTML + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /