From 0e67fa4da06709d76d7a98d27f72354aca1cad69 Mon Sep 17 00:00:00 2001 From: architeuthis Date: Thu, 12 Dec 2024 20:47:35 +0100 Subject: [PATCH] Add system description macro --- preamble.tex | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/preamble.tex b/preamble.tex index 0707535..fc131da 100644 --- a/preamble.tex +++ b/preamble.tex @@ -43,18 +43,26 @@ 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{\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 the guide for its 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*{\finalfootnote}{ \section*{} \vspace*{\fill}