Skip to content

Improvements for version 1.1.0 #73

@OliRom

Description

@OliRom

Here are the things that might be improved with the package version 1.1.0:

  • Automate tasks with a Makefile in the root directory (Olivier). Those tasks might be automated:
    • Generate the documentation, which include generating the .svg images
    • Run the tests
    • Run the tests with coverage
    • Run isort and black (in this order)
    • Run the benchmarks
  • Add benchmarks (Olivier). This includes:
    • Creating the benchmarks
    • Automating the benchmarks generation in the Makefile
  • Implement unitary and size check with decorators (Implement unitary and size checks with a decorator #60 )
  • Enhance the ring submodule (Enhance the ring submodule #44 )
  • Automate tests and release with CI (Automate tests and releases with CI #72 )
  • Add a developper section in the documentation (Add a "Developer" section in the documentation #64 )
  • Add a section in the documentation containing the steps to follow to release a new version of the package (PyPi and ReadTheDocs)
  • Update the README with a documentation link and the PyPi installation instructions (Update Readme with doc link and Pypi installation #59 )
  • Add badges to the README (test coverage, link to PyPI, supported python versions, ...)
  • Make sure the versions available on readthedocs are the right ones
  • Automaticaly update the package version in the documentation and README files using the qdecomp.__version__ variable to avoid duplicate definition
  • Reduce testing time (particularly the test_utils/test_grid_problem/test_rz_approx.py and tests\test_decompositions\test_circuit.py test_decompositions/test_sqg_decomp.py tests).

Sub-issues

Metadata

Metadata

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions