session_1_4_code_project.md

__equs__.Python workshop 2019

Day 1 - Python modules and Git

3. Code project (2+ hours)

Note: to participate in this project you will need a GitHub account.

Now that we have covered how to build Python packagaes and how to work on Python projects on GitHub, let's all collaborate together and build a Python package that can simulate one and two qubit quantum circuits.

We build a skeleton for this package and your task is to write the content and tests for it.

The package is structured as followed:

two_qubit_simulator/
    - __init__.py
    - qubit_register.py
    - quantum_circuit.py
    - quantum_gates/
        - __init__.py
        - quantum_gate.py
        - hadamard.py
        - cnot.py
        - ...
tests/
    - test_qubit_register.py
    - test_quantum_circuit.py
    - test_quantum_gates.py
setup.py
README.md
.pylintrc

The project is hosted here:

https://github.com/equs-python/two-qubit-simulator

Start by making a local clone of the repository and create your own branch. Depending on what part of the project you decide to work on, give your branch a descripitve name.

The plan is to divide the project into the following parts:

• Write the qubit_register.py module + tests
• Write the quantum_circuit.py module + tests
• Write the quantum_gates module + tests
• Write documentation and usage examples
• Optional: write applications

The README.md file contains information of how the individual modules are expected to work. Once you finished writing (and testing!) a piece of your code, make a pull request to the master branch. Any PR made to this branch will have to pass the automated tests and linting before it can be merged. We encourage all of you to review each others PRs.