Add `pyEPR` to `QHFSSEigenmodePyaedt`

[clarkmiyamoto]

What are the issues this pull addresses (issue numbers / links)?

https://github.com/Qiskit/qiskit-metal/issues/950

Did you add tests to cover your changes (yes/no)?

No - unsure how to add tests to ANSYS level code... Please advise.

Did you update the documentation accordingly (yes/no)?

Yes

Did you read the CONTRIBUTING document (yes/no)?

Yes

Summary

Added energy-participation ratio analysis using QHFSSEigenmodePyaedt renderer by using pyEPR. Nice temporary fix until someone implements pyEPR only using pyAEDT.

Details and comments

Changes in QHFSSPyaedt‎

• Added method set_variable. Allows front-end users to set a project-level variable in ANSYS.

Changes in QHFSSEigenmodePyaedt

• Added attribute default_pyepr_options for default settings associated w/ EPR analysis
• Updated method add_hfss_em_setup to return SetupHFSS object
• Added method analyze_setup. Allows front-end users to analyze the setup they created in add_hfss_em_setup.
• Added method run_epr. Allows front-end users to run EPR analysis on their designs.
  • Added these supporting methods.
  • setup_jjs_for_epr: Automatically finds rendered Josephson Junctions in ANSYS, sets them up in pyEPR.ProjectInfo.junctions.
  • setup_dielectric_for_epr: Find names of specified dielectrics, sets them up in pyEPR.ProjectInfo.dissipative['dielectric_surfaces'].
  • epr_spectrum_analysis: Runs EPR analysis.
  • epr_report_hamiltonian: Generates .md compatible report of results from EPR analysis.

Added tutorial on how to QHFSSEigenmodePyaedt.

• Example supported: Single Transmon

[clarkmiyamoto]

Also side note. I noticed other pieces of code aren't yapf formatted, should I be running this or have it routed to only my code? I wouldn't want to break anything.

yapf --in-place --recursive --style ./.style.yapf .

I currently modify it to run only the sections I've changed. yapf --in-place --recursive --style ./.style.yapf ./qiskit_metal/renderers/renderer_ansys_pyaedt