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, force])

Open the Quantum / Qiskit Metal documentation in a web browser.
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/', force=False)[source]

Open the Quantum / Qiskit Metal documentation in a web browser.

Parameters:

  • page – URL to open. Defaults to the published docs site.

  • force – If True, always pop the browser, even in headless / CI / notebook-execute contexts. Defaults to False so that running this cell during tox -e docs, nbsphinx notebook execution, “Restart & Run All”, or on a headless Linux server / Colab kernel won’t repeatedly launch the user’s browser. In those cases the URL is printed instead.