datasheets/preamble.tex

73 lines
2.9 KiB
TeX

\documentclass[10pt]{datasheet}
\usepackage{palatino}
\usepackage{textgreek}
\usepackage{minted}
\usepackage{tcolorbox}
\usepackage{etoolbox}
\usepackage[justification=centering]{caption}
\usepackage[utf8]{inputenc}
\usepackage[english]{babel}
\usepackage[english]{isodate}
\usepackage{graphicx}
\usepackage{subfig}
\usepackage{tikz}
\usepackage{pgfplots}
\pgfplotsset{compat=1.18}
\usepackage{circuitikz}
\usepackage{pifont}
\usetikzlibrary{calc}
\usetikzlibrary{fit,backgrounds}
\newcommand*{\twocm}[3][2cm]{\parbox{#1}{\centering #2 \\ #3}}
\newcommand*{\fourcm}[3][4cm]{\parbox{#1}{\centering #2 \\ #3}}
\newcommand{\inputcolorboxminted}[3][4]{%
\begin{tcolorbox}[colback=white]
\inputminted[#2, gobble=#1]{python}{#3}
\end{tcolorbox}
}
\newcommand{\repeatfootnote}[1]{\textsuperscript{\ref{#1}}}
\newcommand*{\sourcesection}[2]{
\section{Source}
#1, like all the Sinara hardware family, is open-source hardware, and design files (schematics, PCB layouts, BOMs) can be found in detail at the repository \url{#2}.
}
\newcommand*{\sourcesectiond}[4]{
\section{Source}
#1 and #2, like all the Sinara hardware family, are open-source hardware, and design files (schematics, PCB layouts,
BOMs) can be found in detail at the repositories \url{#3} and \url{#4}.
}
\newcommand{\sysdescsection}{
\section{ARTIQ System Description Entry}
ARTIQ/Sinara firmware/gateware is generated according to a JSON system description file, allowing gateware to be specific to and optimized for a certain system configuration.
% It isn't possible to use verbatim environments within \newcommand macros
% so the minted colorbox is easier to use directly in each file
}
\newcommand{\codesection}[1]{
\section{Example ARTIQ Code}
The sections below demonstrate simple usage scenarios of extensions on the ARTIQ control system. These extensions make use of the resources of the #1. They do not exhaustively demonstrate all the features of the ARTIQ system.
The full documentation for ARTIQ software and gateware, including guides for their use, is available at \url{https://m-labs.hk/artiq/manual/}. Please consult the manual for details and reference material of the functions and structures used here.
}
\newcommand*{\ordersection}[1]{
\section{Ordering Information}
To order, please visit \url{https://m-labs.hk} and choose #1 in the ARTIQ/Sinara hardware selection tool. Cards can be ordered as part of a fully-featured ARTIQ/Sinara crate or standalone through the 'Spare cards' option. Otherwise, orders can also be made by writing directly to \url{mailto:sales@m-labs.hk}.
}
\newcommand*{\finalfootnote}{
\section*{}
\vspace*{\fill}
\begin{footnotesize}
Information furnished by M-Labs Limited is provided in good faith in the hope that it will be useful. However, no responsibility is assumed by M-Labs Limited for its use. Specifications may be subject to change without notice.
\end{footnotesize}
}