Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: replace some usage of "h-series" #563

Merged
merged 6 commits into from
Jan 23, 2025
Merged

docs: replace some usage of "h-series" #563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
08175bd
replace some h-series usage in the docs
CalMacCQ Jan 15, 2025
e1f4780
remove usage in calendar functions
CalMacCQ Jan 15, 2025
25cf84e
fix a weird RemoveBarriers sphinx warning
CalMacCQ Jan 15, 2025
4125f83
make suggested changes
CalMacCQ Jan 23, 2025
33befbf
Merge branch 'main' into rename/h-series
CalMacCQ Jan 23, 2025
b93a580
Merge branch 'main' into rename/h-series
CalMacCQ Jan 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API documentation

The pytket-quantinuum extension allows submission of pytket circuits to the H-series trapped ion devices (and emulators) via the {py:class}`QuantinuumBackend`.
The pytket-quantinuum extension allows submission of pytket circuits to Quantinuum systems (and emulators) via the {py:class}`QuantinuumBackend`.

See the [pytket-quantinuum section](https://docs.quantinuum.com/h-series/trainings/getting_started/pytket_quantinuum/pytket_quantinuum.html) of the documentation website for some example usage.

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ and Windows. To install, run:
pip install pytket-quantinuum
```

For example usage see the [pytket-quantinuum section](https://docs.quantinuum.com/h-series/trainings/getting_started/pytket_quantinuum/pytket_quantinuum.html) of the H-series documentation.
For example usage see the [pytket-quantinuum section](https://docs.quantinuum.com/h-series/trainings/getting_started/pytket_quantinuum/pytket_quantinuum.html) of the Quantinuum Systems documentation.

:::{note}
pytket-quantinuum is not compatible with Quantinuum Nexus. For guidance on how to access H-Series through Nexus, please see the [Nexus documentation](https://docs.quantinuum.com/nexus) and the [qnexus](https://pypi.org/project/qnexus/) Python package.
Expand Down Expand Up @@ -102,7 +102,7 @@ the circuit 2-qubit gate count is not reduced after compilation.
* - [AutoRebase [2]](inv:#*.AutoRebase)
- [SynthesiseTket](inv:#*.SynthesiseTket)
- [FullPeepholeOptimise [3]](inv:#*.passes.FullPeepholeOptimise)
- [RemoveBarriers](inv:#*pytket.passes.RemoveBarriers)
- [RemoveBarriers](inv:#*pytket._tket.passes.RemoveBarriers)
Copy link
Contributor Author

@CalMacCQ CalMacCQ Jan 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a separate fix required to resolve a sphinx warning. Looks weird to have the _tket in there but have verfied that it'll resolve correctly in the deployed site.

* - [FlattenRelabelRegistersPass](inv:#*.FlattenRelabelRegistersPass)
- [NormaliseTK2 [5]](inv:#*.passes.NormaliseTK2)
- [NormaliseTK2 [5]](inv:#*.passes.NormaliseTK2)
Expand Down
10 changes: 5 additions & 5 deletions pytket/extensions/quantinuum/backends/quantinuum.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,7 @@ def get_calendar(
end_date: datetime.datetime,
localise: bool = True,
) -> list[dict[str, Any]]:
"""Retrieves the Quantinuum H-Series operations calendar
"""Retrieves the Quantinuum operations calendar
for the period specified by start_date and end_date.
The calendar data returned is for the local timezone of the
end-user.
Expand All @@ -482,7 +482,7 @@ def get_calendar(
The dictionary has the following properties.
* 'start-date': The start date and start time as a datetime.datetime object.
* 'end-date': The end date and end time as a datetime.datetime object.
* 'machine': A string specifying the H-Series device attached to the event.
* 'machine': A string specifying the device attached to the event.
* 'event-type': The type of event as a string. The value `online` denotes queued
access to the device, and the value `reservation` denotes priority access
for a particular organisation.
Expand All @@ -500,7 +500,7 @@ def get_calendar(
:param localise: Apply localization to the datetime based
on the end-users time zone. Default is True. Disable by
setting False.
:return: A list of events from the H-Series operations calendar,
:return: A list of events from the operations calendar,
sorted by the `start-date` of each event. Each event is a python
dictionary.
:return_type: List[Dict[str, str]]
Expand Down Expand Up @@ -560,7 +560,7 @@ def view_calendar(
fontsize: float = 15,
titlesize: float = 40,
) -> "matplotlib.figure.Figure":
"""Visualise the H-Series operations calendar for a user-specified
"""Visualise the operations calendar for a user-specified
month and year. The operations hours are shown for the machine name
used to construct the QuantinuumBackend object, i.e. 'H1-1'. Operations
days are coloured. In addition, a description of the event is also
Expand All @@ -574,7 +574,7 @@ def view_calendar(
matplotlib.figure.Figure.
:param fontsize: The fontsize of the event description within the
calendar.
:return: A matplotlib.figure.Figure visualising the H-Series
:return: A matplotlib.figure.Figure visualising the
calendar for a user-specified calendar month.
:return_type: matplotlib.figure.Figure
"""
Expand Down
Loading