Skip to content

Commit 0464af1

Browse files
kpeeterskpeeters
committed
Update docs.
1 parent 103da7a commit 0464af1

File tree

4 files changed

+83
-21
lines changed

4 files changed

+83
-21
lines changed

‎doc/the_cadabra_book.bib‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
@article{kas_cdb_hep,
2+
author = "Peeters, Kasper",
3+
title = "{Introducing Cadabra: a symbolic computer algebra system for field theory problems}",
4+
eprint = "hep-th/0701238",
5+
year = "2007"
6+
}
7+
@Article{Peeters:2003pv,
8+
author = "Peeters, Kasper and Westerberg, Anders",
9+
title = "{The Ramond-Ramond sector of string theory beyond leading order}",
10+
journal = "Class. Quant. Grav.",
11+
volume = "21",
12+
year = "2004",
13+
pages = "1643-1666",
14+
eprint = "hep-th/0307298",
15+
SLACcitation = "%%CITATION = HEP-TH 0307298;%%"
16+
}
17+
@Article{Peeters:2000qj,
18+
author = "Kasper Peeters and Pierre Vanhove and Anders Westerberg",
19+
title = "Supersymmetric higher-derivative actions in ten and eleven
20+
dimensions, the associated superalgebras and their
21+
formulation in superspace",
22+
journal = "Class. Quant. Grav",
23+
volume = "18",
24+
year = "2001",
25+
pages = "843-889",
26+
eprint = "hep-th/0010167",
27+
SLACcitation = "%%CITATION = HEP-TH 0010167;%%"
28+
}
29+
@article{Peeters:2018dyg,
30+
author = "Peeters, Kasper",
31+
title = "{Cadabra2: computer algebra for field theory revisited}",
32+
doi = "10.21105/joss.01118",
33+
journal = "J. Open Source Softw.",
34+
volume = "3",
35+
number = "32",
36+
pages = "1118",
37+
year = "2018"
38+
}

‎doc/the_cadabra_book.tex‎

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
\documentclass[11pt]{book}
22
\usepackage[scale=.7]{geometry}
3+
\usepackage{charter}
4+
\usepackage[backend=biber, sorting=none]{biblatex}
35
\usepackage{textfit}
46
\usepackage{relsize}
57
\usepackage{setspace}
@@ -9,7 +11,7 @@
911
\usepackage[fleqn]{amsmath}
1012
\usepackage{color}
1113
\usepackage{changepage}
12-
\usepackage[colorlinks=true, urlcolor=black, plainpages=false, pdfpagelabels]{hyperref}
14+
\usepackage[colorlinks=true, linkcolor=red, citecolor=red, urlcolor=black, plainpages=false, pdfpagelabels]{hyperref}
1315
\usepackage{etoolbox}
1416
\usepackage{amssymb}
1517
\usepackage[parfill]{parskip}
@@ -44,7 +46,7 @@
4446
\relpenalty=10
4547
\binoppenalty=10
4648
\hyphenpenalty=10
47-
\raggedright
49+
%\raggedright
4850

4951
%\usepackage[most]{tcolorbox}
5052

@@ -83,6 +85,21 @@
8385

8486
\ytableausetup{centertableaux} % smalltableaux
8587

88+
% Chapter and section headers.
89+
\usepackage[compact]{titlesec}
90+
91+
\newcommand{\chapterformat}[1]{\LARGE\larger\bfseries \hspace{3mm}#1}
92+
93+
\titleformat{\chapter}[block]
94+
{\large\bfseries}{}{0pt}{\hfill{\color[rgb]{.5,.5,.5}{%
95+
\bfseries\scaletoheight{2cm}{\thechapter}}}%
96+
\\\hbox{~}\hfill\chapterformat}
97+
98+
99+
100+
\bibliography{the_cadabra_book}
101+
102+
86103
\begin{document}
87104
\pagestyle{empty}
88105
\ThisLRCornerWallPaper{1.0}{book_cover}
@@ -151,20 +168,17 @@ \section{Cadabra's design philosophy}
151168

152169
\section{History}
153170

154-
Cadabra was originally written around 2001 to solve <a
155-
href="https://arxiv.org/abs/hep-th/0010167">a number</a> <a
156-
href="https://arxiv.org/abs/hep-th/0307298">of problems</a> related to
157-
higher-derivative supergravity. It was then expanded and polished, and
158-
first saw its public release <a
159-
href="https://arxiv.org/abs/hep-th/0701238">in 2007</a>. During the
160-
years that followed, it became clear that several design decisions
161-
were not ideal, such as the use of a custom programming language and
162-
the lack of functionality for component computations. Over the course
163-
of 2015-2016 a large rewrite took place, which resulted in Cadabra
164-
2.x. This new version is programmable in Python and does both
165-
abstract and component computations. This new web site, with new
166-
tutorials and all manual pages accessible online, will also hopefully
167-
help to make Cadabra easier to use.
171+
Cadabra was originally written around 2001 to solve a number of
172+
problems related to higher-derivative
173+
supergravity~\cite{Peeters:2000qj,Peeters:2003pv}. It was then
174+
expanded and polished, and first saw its public release in
175+
2007~\cite{kas_cdb_hep}. During the years that followed, it became
176+
clear that several design decisions were not ideal, such as the use of
177+
a custom programming language and the lack of functionality for
178+
component computations. Over the course of 2015-2016 a large rewrite
179+
took place, which resulted in Cadabra 2.x~\cite{Peeters:2018dyg}.
180+
This new version is programmable in Python and does both abstract and
181+
component computations.
168182

169183

170184
\chapter{The input format}
@@ -189,4 +203,8 @@ \chapter{Writing your own packages}
189203
\chapter{Algorithms}
190204
\input{distribute}
191205

206+
%\bibliographystyle{cadabra}
207+
208+
\printbibliography
209+
192210
\end{document}

‎examples/ref_properties.cnb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -534,14 +534,14 @@
534534
"cells" :
535535
[
536536
{
537-
"cell_id" : 10819283058881207059,
537+
"cell_id" : 3108229061098778346,
538538
"cell_origin" : "client",
539539
"cell_type" : "latex_view",
540-
"source" : "\\subsection*{Querying properties}\n\nFor many built-in algorithms, assigning properties is sufficient to the objects which appear in your expressions\nwill be enough to make them work. However, sometimes you may want to explicitly query whether a particular symbol\nhas a particular property. The following example shows how this works."
540+
"source" : "\\subsection*{Querying properties}\n\nFor many built-in algorithms, assigning properties to the objects which appear in your expressions\nwill be enough to make them work. However, sometimes you may want to explicitly query whether a particular symbol\nhas a particular property. The following example shows how this works."
541541
}
542542
],
543543
"hidden" : true,
544-
"source" : "\\subsection*{Querying properties}\n\nFor many built-in algorithms, assigning properties is sufficient to the objects which appear in your expressions\nwill be enough to make them work. However, sometimes you may want to explicitly query whether a particular symbol\nhas a particular property. The following example shows how this works."
544+
"source" : "\\subsection*{Querying properties}\n\nFor many built-in algorithms, assigning properties to the objects which appear in your expressions\nwill be enough to make them work. However, sometimes you may want to explicitly query whether a particular symbol\nhas a particular property. The following example shows how this works."
545545
},
546546
{
547547
"cell_id" : 9613954587245120616,

‎web2/CMakeLists.txt‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,13 +277,19 @@ endforeach()
277277
message(STATUS "Book will be created in ${BOOKOUTDIR}")
278278
add_custom_command(
279279
OUTPUT ${BOOKOUTDIR}/the_cadabra_book.pdf
280-
DEPENDS ${CMAKE_SOURCE_DIR}/doc/the_cadabra_book.tex ${CMAKE_SOURCE_DIR}/doc/book_cover.pdf ${ALLTEX}
280+
DEPENDS ${CMAKE_SOURCE_DIR}/doc/the_cadabra_book.tex
281+
${CMAKE_SOURCE_DIR}/doc/book_cover.pdf
282+
${CMAKE_SOURCE_DIR}/doc/the_cadabra_book.bib ${ALLTEX}
281283
COMMAND cp
282-
ARGS ${CMAKE_SOURCE_DIR}/doc/the_cadabra_book.tex ${BOOKOUTDIR}/
284+
ARGS ${CMAKE_SOURCE_DIR}/doc/the_cadabra_book.tex
285+
${CMAKE_SOURCE_DIR}/doc/the_cadabra_book.bib
286+
${BOOKOUTDIR}/
283287
COMMAND cp
284288
ARGS ${CMAKE_SOURCE_DIR}/doc/book_cover.pdf ${BOOKOUTDIR}/
285289
COMMAND pdflatex
286290
ARGS the_cadabra_book.tex
291+
COMMAND biber
292+
ARGS the_cadabra_book
287293
COMMAND pdflatex
288294
ARGS the_cadabra_book.tex
289295
COMMAND pdflatex

0 commit comments

Comments
 (0)