Refactor: Restructure qBraid-Algorithms, update docs, and fix functionality

[vinayswamik]

Motivation

This PR focuses on improving the qBraid-Algorithms library by addressing structural issues, enhancing documentation, and correcting functionality.

Summary

• Restructured code for better organization and readability

  • Updated function names from load_program to generate_program and generate_subroutine to save_to_qasm for consistency across the documentation and implementation.
  • Adjusted example usages in the README and Jupyter notebooks to reflect the new function names.
  • Removed obsolete QASM files related to the algorithms to streamline the codebase.

• Updated and clarified documentation

  • Enhanced documentation in various modules, including detailed descriptions for available algorithms.
  • Added formulation and algorithm steps to improve clarity and understanding.
  • Updated CSS for documentation styling and added custom styles for better presentation.
  • Included new features and key points in the overview section of the documentation.

• Fixed functionality errors in existing implementations

• Update Jupyter notebooks and improve HHL algorithm implementation

  • Refactored the HHL algorithm to enhance input validation and error handling.
  • Updated the QPE notebook to include improved result processing and visualization.
  • Added new example notebook for HHL algorithm.

Purpose

These changes aim to improve maintainability, usability, and overall consistency within the qBraid-Algorithms library.

Notes

Further changes and improvements will continue to be added to this PR.

[codecov]

Codecov Report

❌ Patch coverage is 78.39721% with 62 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
qbraid_algorithms/hhl/hhl.py	0.00%	27 Missing ⚠️
qbraid_algorithms/qpe/phase_est.py	54.16%	11 Missing ⚠️
qbraid_algorithms/qtran/gate_library.py	86.84%	5 Missing ⚠️
qbraid_algorithms/embedding/prep_sel.py	89.18%	4 Missing ⚠️
qbraid_algorithms/qtran/qasm_builder.py	71.42%	4 Missing ⚠️
qbraid_algorithms/rodeo/rodeo.py	87.50%	4 Missing ⚠️
qbraid_algorithms/qtran/module_loader.py	0.00%	3 Missing ⚠️
...aid_algorithms/amplitude_amplification/amp_ampl.py	66.66%	1 Missing ⚠️
qbraid_algorithms/embedding/toeplitz.py	87.50%	1 Missing ⚠️
qbraid_algorithms/evolution/gqsp.py	92.30%	1 Missing ⚠️
... and 1 more

📢 Thoughts on this report? Let us know!

[TheGupta2012]

Looks good