Rename top-level module to circuit_knitting

[garrison]

This performs the renames porposed in #221 and thus closes #221.

In order to demonstrate that the deprecated import locations work, I have not updated the imports in the tests or notebooks yet. I'll do that once CI passes.

I also made it so docs will no longer deploy for pushes to main, since main will now be ahead of the current stable release.

[github-actions]

Pull Request Test Coverage Report for Build 5183607457

• 16 of 16 (100.0%) changed or added relevant lines in 5 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 89.63%

---

Totals
Change from base Build 5183297038:	0.0%
Covered Lines:	2325
Relevant Lines:	2594

---

💛 - Coveralls

[caleb-johnson]

Could you explain what is going on with setting these modules? Not really familiar

[garrison]

It tells the module system that if somebody tries to import a module called circuit_knitting_toolbox.circuit_cutting.qpd, then instead use this other thing that's already been loaded, which in this case is circuit_knitting.cutting.qpd.

This is explained at bit at https://stackoverflow.com/a/72244240/1558890. (I tried the lazy method mentioned there too, but it had more issues than was worth.)

[caleb-johnson]

So users will have access to two namespaces, and one of the namespaces will throw a bunch of warnings?

[garrison]

Exactly.

[caleb-johnson]

This looks really great, nice job. I had a couple questions out of interest but lgtm

[caleb-johnson]

One more thing, should we rename the docs directories to cutting and forging ?

[garrison]

One more thing, should we rename the docs directories to cutting and forging ?

This was an intentional choice, but we could re-evaluate. Quoting from #221:

Let's keep the documentation directories the way they are rather than replace circuit_cutting and entanglement_forging with shorter names. This will

• prevent links from unnecessarily breaking
• provide more descriptive names to people navigating the documentation, e.g., the tutorials

[caleb-johnson]

One more thing, should we rename the docs directories to cutting and forging ?

This was an intentional choice, but we could re-evaluate. Quoting from #221:

Let's keep the documentation directories the way they are rather than replace circuit_cutting and entanglement_forging with shorter names. This will

• prevent links from unnecessarily breaking
• provide more descriptive names to people navigating the documentation, e.g., the tutorials

I agree with both. I don't think this is a source of confusion

[caleb-johnson]

Aren't deprecations normally replaced with a new target or a new way to migrate? How is this different? Isn't it a deprecation?

[caleb-johnson]

I would think the clean-up of the old package would be an upgrade, but I'm no authority on this :)