qldpc.external package

Submodules

qldpc.external.codes module

Module for loading error-correcting codes from the GAP computer algebra system

Copyright 2023 The qLDPC Authors and Infleqtion Inc.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

qldpc.external.codes.get_code(code: str) → tuple[list[list[int]], int | None][source]: Retrieve a group from GAP.

qldpc.external.groups module

Module for loading groups from the GAP computer algebra system

Copyright 2023 The qLDPC Authors and Infleqtion Inc.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

qldpc.external.groups.gap_is_installed() → bool[source]: Is GAP 4 installed?

qldpc.external.groups.get_gap_result(*commands: str) → CompletedProcess[str][source]: Get the output from the given GAP commands.

qldpc.external.groups.get_generators(group: str) → list[list[tuple[int, ...]]][source]: Retrieve GAP group generators.

qldpc.external.groups.get_generators_from_groupnames(group: str) → list[list[tuple[int, ...]]] | None[source]: Retrieve GAP group generators from GroupNames.org.

qldpc.external.groups.get_generators_with_gap(group: str) → list[list[tuple[int, ...]]] | None[source]: Retrieve GAP group generators from GAP directly.

qldpc.external.groups.get_group_url(order: int, index: int) → str | None[source]: Retrieve the webpage of an indexed GAP group on GroupNames.org.

qldpc.external.groups.get_small_group_number(order: int) → int[source]: Get the number of ‘SmallGroup’s of a given order.

qldpc.external.groups.get_small_group_structure(order: int, index: int) → str[source]: Get a description of the structure of a SmallGroup from GAP.

qldpc.external.groups.maybe_get_webpage(order: int) → str | None[source]: Try to retrieve the webpage listing all groups up to a given order.

qldpc.external.groups.sanitize_gap_commands(commands: Sequence[str]) → tuple[str, ...][source]: Sanitize GAP commands: don’t format Print statements, and quit at the end.

Module contents