about#

Reports a summary of information on Qiskit Metal and dependencies.

Contain functions to report more detailed information to orient a user, used for debug purposes.

Functions

about()

Reports a summary of information on Qiskit Metal and dependencies.

get_module_doc_page(module[, folder, page])

Get the file path to a module doc folder assumed to be inside the package.

get_platform_info()

Returns a string with the platform information.

open_docs([page])

Open the qiskit_metal documentation in HTML.
about()[source]#

Reports a summary of information on Qiskit Metal and dependencies.

Returns:

About message

Return type:

str

get_module_doc_page(module, folder='../docs/build/html', page='index.html')[source]#

Get the file path to a module doc folder assumed to be inside the package.

get_platform_info() → str[source]#

Returns a string with the platform information.

open_docs(page='https://qiskit-community.github.io/qiskit-metal/')[source]#

Open the qiskit_metal documentation in HTML.

Open the URL in new window, raising the window if possible.