Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.3 #22

Merged
merged 50 commits into from
Aug 24, 2024
Merged

Release 0.3 #22

merged 50 commits into from
Aug 24, 2024

Conversation

glassnotes
Copy link
Contributor

@glassnotes glassnotes commented Jul 11, 2024

Context: Updates to Ionizer to add new features and documentation, conform to updated versions of libraries and APIs, and establish better software development practices.

Description of the Change:

  • set up pre-commit hooks and CI pipeline to format and lint code, and run tests
  • switch dependency management to Poetry
  • render documentation on readthedocs
  • make the library installable via pip

Benefits: All of the above!

Possible Drawbacks: None

Related GitHub Issues: None

Gabriel-Bottrill and others added 18 commits May 15, 2024 17:23
Add pre-commit hooks and update formatting / linting to use ruff
* Add readthedocs yaml file

* Add rst files for sphinx documentation. Adjust some docstrings to conform.

* Restructuring documentation files so web-based docs can be built.

* Rename docs directory

* Fix path in conf.py file

* Update readthedocs yaml to use poetry

* Update poetry lock file

* Revert change to python version.

* Add MS gate matrix example. Convert all docstrings to raw strings.

* Restructure docs files. Add instructions and basic usage.

* Update lock file

* Fix math rendering in many docs

* Clarify docs for identity hunter.

* Fix formatting in docs

* Fix formatting in docs

* Formatting fix

* Example for commute_through_ms_gates

* Examples for virtualize_rz_gates and single_qubit_fusion_gpi

* Update convert_to_gpi and add example

* Add inverse cancellation pass

* Example for ionize transform

* Hide more contents of identity hunter module. Small text tweaks.

* Example for lookup gate identity

* Finish documenting utils. Update a JSON parameter based on new API.

* Fix typo

* Remove transform utils from docs. Fix tests for new API

* Restructure identity hunter module

* Run precommit hooks

* Try enabling source linking

* Remove attempted source link

---------

Co-authored-by: Olivia Di Matteo <[email protected]>
@glassnotes glassnotes added this to the v0.3 milestone Aug 24, 2024
* Add equivalence checking mechanism to transforms and tests

* Relocate equivalence checker. Add a test suite for it.

* Add description of equivalence checking to docs.

* Push changes to basic usage section.

* Remove print statements from tests
* Example for flag_non_equivalence utility function

* Update README to reflect new instructions

* Fix formatting of links in README

* Add docs badge to README

* Remove broken badge.
@glassnotes glassnotes marked this pull request as ready for review August 24, 2024 21:42
@glassnotes glassnotes merged commit d862117 into main Aug 24, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants