##############################################################################
# Copyright 2016-2019 Rigetti Computing
#
# 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.
##############################################################################
"""Convert a ``Program`` to a LaTeX quantum circuit diagram.
Note: this is a deprecated module: Import from pyquil.latex instead.
"""
from typing import Optional
from deprecated.classic import deprecated
from pyquil.latex._diagram import DiagramSettings
from pyquil.quil import Program
[docs]
@deprecated(
version="4.0",
reason="This module has been moved -- please import it as 'from pyquil.latex import to_latex' going forward",
)
def to_latex(circuit: Program, settings: Optional[DiagramSettings] = None) -> str:
"""Produce a circuit diagram in LaTeX for a given pyQuil Program."""
from pyquil.latex._main import to_latex
return to_latex(circuit, settings)