README.md

usecase-template

An example qubrabench use-case

Usage

Add your code in folder usecase/.

Recommended structure:

.
├── requirements.txt       # add all dependencies here
└── usecase
    ├── algorithm.py       # source code for your implementation
    ├── algorithm_test.py  # unittests for above code
    └── algorithm.ipynb    # notebook with executions of the algorithm, example usages, plots, visualizations etc.

Testing

If you want to edit the project or run tests, first install all dependencies using:

pip install -r requirements.txt

Then run pytest to run all tests. You can alternatively run make to run all tests run by the CI.