Rust code

[ciaranra]

Including Rust code for stabilizer simulator.

TODO:

• [x] Have CI workflow that checks Rust tests and formatting
• [x] Update Makefiles to build etc. both Rust and Python projects given restructuring
• [x] Have CI workflow that builds and install pecos-rslib and tests pecos-rslib
• [x] Have CI workflow that tests the usage of pecos-rslib from Python PECOS
• [x] Add PyO3 wrapping for Rust simulators and make available to Python via pecos-rslib
• [x] Update tests to test Rust simulators used in Python PECOS
• [x] Add RSSparseSim to Python test_random_circuits (likely need to add force_outcome measurement)
• [x] Add Rust tests for the newly added gates for the Rust stabilizer sim
• [x] Update/modify various Readmes as appropriate...
• [x] Use symlinks to point to the appropriate legal and Readme stuff
• [x] Have CI workflow that is generates sdists and wheels for all the Python packages
• [x] Add version consistency checks for Python packages and Rust crates
• [x] Update workflow to save artifacts only on success merges, direct pushes, or py- tags in main branches
• [x] Update README.md if needed

[peter-campora]

Oh boy CRA, this is a monster PR. I think it would help if you have some examples of the kinds of tests you would like the PR reviewers to run on this

[ciaranra]

Hehe, yeah it is a monster. Let me single out some smaller stuff for people to maybe concentrate on if they want to...

[ciaranra]

If you are up for reviewing this monster of a PR, here are some things that you can take a look at:

• Makefile: After reading the README and checking out the Makefile is it clear what to do? Do the relevant targets make sense? Maybe take the makefile out for a spin and see if you can build and test with it?
• README: Do you think there is anything glaringly missing for users or developers?
• Workflows: New workflows have been added to test and build both the Rust and Python code: .github/workflows. If you want you can see if all the testing and linting look right. The workflows look like they are doing their jobs properly... python-release.yml is a bit of a beast, but it is mainly a utility for building distributions to be uploaded to pypi
• tests... the tests are fairly extensive and probably more for people who are comfortable with stabilizer simulations. If you want to take a look at them... they are in crates/pecos-qsims/src/sparse_stab.rs (at the bottom of the file), in here python/tests/pecos/integration/state_sim_tests/test_stab_sims/, and here python/tests/pecos/integration/test_random_circuits.py. The Rust stabilizer simulator is probably better tested then the Python one. lol
• General structure: Does the general approach and structure of files for this monolithic repo seem okay?

[ciaranra]

New TODO:

• [x] Add license headers to all code
• [x] Remove Rust code unless it is supporting the specific stabilizer sim implementation that is fully baked out (@peter-campora is keeping me honest... sigh... lol)

[ciaranra]

Mostly just tried to work through the development section of the README.

make test-all gave me:

======== short test summary info ========
FAILED docs/api_guide/circuit_runners.rst::circuit_runners.rst
FAILED docs/api_guide/decoders.rst::decoders.rst
FAILED docs/api_guide/error_generators.rst::error_generators.rst
FAILED docs/api_guide/qeccs.rst::qeccs.rst
FAILED docs/api_guide/simulators.rst::simulators.rst
FAILED docs/examples/creating_qecc_class.rst::creating_qecc_class.rst
FAILED docs/examples/stab_code_verification.rst::stab_code_verification.rst
======== 7 failed, 2 passed, 1 warning in 0.82s ========

This should be resolved now. Just removing doc tests for now.

[ciaranra]

Alright, @qartik & @peter-campora. I have updated the makefile to make the .venv more of a "first class citizen" and updated the README appropriately (hopefully). Let me know if you still have issues.

I still need to figure out what is going on with this:

-pecos-rslib==0.6.0.dev6 +pecos-rslib==version = 0.6.0.dev6