Commit ed8d8676 authored by Liam Healy's avatar Liam Healy

Documentation, test

Added "Getting Started" chapter to the documentation. Generated
LaTeX/PDF form of Sphinx documentation. Added definition so that
(asdf:test-system :antik) will work, and tests both ANTIK and GRID
packages.
parent a3142410
;;
;; Liam Healy 2012-02-20 10:14:49EST physical-dimension.asd
;; Time-stamp: <2015-03-12 22:39:51EDT antik.asd>
;; Time-stamp: <2015-11-15 15:05:52EST antik.asd>
;; Copyright 2015 Liam M. Healy
;; Distributed under the terms of the GNU General Public License
......@@ -32,17 +32,21 @@
((:module mathematics
:serial t
:components
((:file "integers")
(:file "trigonometry")))
((:file "integers")
(:file "trigonometry")))
(:module optimize
:components
((:file "one-dim")
(:file "one-dim-pq")
(:file "least-squares")))
((:file "one-dim")
(:file "one-dim-pq")
(:file "least-squares")))
(:module linear-algebra
:components
((:file "linear-algebra")
(:file "linear-algebra-tests")))
((:file "linear-algebra")
(:file "linear-algebra-tests")))
(:module sample
:components
((:file "low-discrepancy-sequence")))))
((:file "low-discrepancy-sequence"))))
:perform (asdf:test-op
(o c)
(uiop:symbol-call :lisp-unit '#:run-tests :all :antik)
(uiop:symbol-call :lisp-unit '#:run-tests :all :grid)))
documentation/build/html/root.html
\ No newline at end of file
documentation/build/latex/Antik.pdf
\ No newline at end of file
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: dfad2d8c6d7df9d960ef1d32f91d9692
config: 0583f5cb403f591c8a4eb836577b4484
tags: 645f666f9bcd5a90fca523b33c5a78b7
.. _systems-packages:
Systems and Packages
====================
......
......@@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Antik's documentation!
Antik
=================================
Contents:
......@@ -12,6 +12,7 @@ Contents:
:maxdepth: 2
intro
starting
packages
elemmath
utility
......
Getting Started
=====================
.. highlight:: lisp
Antik is normally installed using Quicklisp_. Once Antik is loaded, it is advisable to set the default package to ``ANTIK-USER`` which is provided to make using Antik easier; see :ref:`systems-packages` for more details. Reader macros are defined by Antik for convenience in specifying physical dimension quantities, dates and times, and grids. These can be enabled with ``set-reader``. This also sets the default floating point read type to ``double-float``::
(ql:quickload :antik)
(in-package :antik-user)
(set-reader)
As a reassurance that the system is installed and working correctly, run the defined regression tests::
> (asdf:test-system :antik)
Unit Test Summary
| 93 assertions total
| 93 passed
| 0 failed
| 0 execution errors
| 0 missing tests
Unit Test Summary
| 88 assertions total
| 88 passed
| 0 failed
| 0 execution errors
| 0 missing tests
T
The first tests definitions in the ``ANTIK`` package and the second in the ``GRID`` package. In examples given in this manual, the ``>`` at the begining of the line is the Lisp REPL_ prompt, indicated the user-typed input follows. Your prompt may differ; for example, it could be the name of the current package, e.g. ``ANTIK-USER>``.
.. _Quicklisp: http://quicklisp.org/
.. _REPL: https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop
.. cl:package:: antik
.. cl:function:: set-reader
.. cl:macro:: set-reader-in-file
/*
* default.css_t
* ~~~~~~~~~~~~~
*
* Sphinx stylesheet -- default theme.
*
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: sans-serif;
font-size: 100%;
background-color: #11303d;
color: #000;
margin: 0;
padding: 0;
}
div.document {
background-color: #1c4e63;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 230px;
}
div.body {
background-color: #ffffff;
color: #000000;
padding: 0 20px 30px 20px;
}
div.footer {
color: #ffffff;
width: 100%;
padding: 9px 0 9px 0;
text-align: center;
font-size: 75%;
}
div.footer a {
color: #ffffff;
text-decoration: underline;
}
div.related {
background-color: #133f52;
line-height: 30px;
color: #ffffff;
}
div.related a {
color: #ffffff;
}
div.sphinxsidebar {
}
div.sphinxsidebar h3 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.4em;
font-weight: normal;
margin: 0;
padding: 0;
}
div.sphinxsidebar h3 a {
color: #ffffff;
}
div.sphinxsidebar h4 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.3em;
font-weight: normal;
margin: 5px 0 0 0;
padding: 0;
}
div.sphinxsidebar p {
color: #ffffff;
}
div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
margin: 10px;
padding: 0;
color: #ffffff;
}
div.sphinxsidebar a {
color: #98dbcc;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
/* -- hyperlink styles ------------------------------------------------------ */
a {
color: #355f7c;
text-decoration: none;
}
a:visited {
color: #355f7c;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
/* -- body styles ----------------------------------------------------------- */
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: 'Trebuchet MS', sans-serif;
background-color: #f2f2f2;
font-weight: normal;
color: #20435c;
border-bottom: 1px solid #ccc;
margin: 20px -20px 10px -20px;
padding: 3px 0 3px 10px;
}
div.body h1 { margin-top: 0; font-size: 200%; }
div.body h2 { font-size: 160%; }
div.body h3 { font-size: 140%; }
div.body h4 { font-size: 120%; }
div.body h5 { font-size: 110%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
text-align: justify;
line-height: 130%;
}
div.admonition p.admonition-title + p {
display: inline;
}
div.admonition p {
margin-bottom: 5px;
}
div.admonition pre {
margin-bottom: 5px;
}
div.admonition ul, div.admonition ol {
margin-bottom: 5px;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.topic {
background-color: #eee;
}
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre {
padding: 5px;
background-color: #eeffcc;
color: #333333;
line-height: 120%;
border: 1px solid #ac9;
border-left: none;
border-right: none;
}
tt {
background-color: #ecf0f3;
padding: 0 1px 0 1px;
font-size: 0.95em;
}
th {
background-color: #ede;
}
.warning tt {
background: #efc2c2;
}
.note tt {
background: #d6d6d6;
}
.viewcode-back {
font-family: sans-serif;
}
div.viewcode-block:target {
background-color: #f4debf;
border-top: 1px solid #ac9;
border-bottom: 1px solid #ac9;
}
\ No newline at end of file
......@@ -16,7 +16,7 @@
* Once the browser is closed the cookie is deleted and the position
* reset to the default (expanded).
*
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
......
......@@ -121,7 +121,7 @@
<dl class="function">
<dt id="function:antik:sqrt">
<em class="property">function </em> (<code class="descname">sqrt</code> <em>num</em>)<a class="headerlink" href="#function:antik:sqrt" title="Permalink to this definition"></a></dt>
<dd><p>The square root of the generalized or regular number.</p>
<dd><p>The square root <span class="math">\(\\sqrt{x}\)</span> of the generalized or regular number <span class="math">\(x\)</span>.</p>
</dd></dl>
<dl class="function">
......
......@@ -214,6 +214,14 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="starting.html#function:antik:set-reader">set-reader (Lisp function)</a>
</dt>
<dt><a href="starting.html#macro:antik:set-reader-in-file">set-reader-in-file (Lisp macro)</a>
</dt>
<dt><a href="elemmath.html#function:antik:signum">signum (Lisp function)</a>
</dt>
......@@ -221,12 +229,12 @@
<dt><a href="elemmath.html#function:antik:sin">sin (Lisp function)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="elemmath.html#function:antik:sinh">sinh (Lisp function)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="elemmath.html#function:antik:sqrt">sqrt (Lisp function)</a>
</dt>
......
......@@ -25,8 +25,8 @@
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="Antik 0 documentation" href="root.html" />
<link rel="next" title="Systems and Packages" href="packages.html" />
<link rel="prev" title="Welcome to Antik’s documentation!" href="root.html" />
<link rel="next" title="Getting Started" href="starting.html" />
<link rel="prev" title="Antik" href="root.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
......@@ -36,10 +36,10 @@
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="packages.html" title="Systems and Packages"
<a href="starting.html" title="Getting Started"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="root.html" title="Welcome to Antik’s documentation!"
<a href="root.html" title="Antik"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="root.html">Antik 0 documentation</a> &raquo;</li>
</ul>
......@@ -64,10 +64,10 @@
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="root.html"
title="previous chapter">Welcome to Antik&#8217;s documentation!</a></p>
title="previous chapter">Antik</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="packages.html"
title="next chapter">Systems and Packages</a></p>
<p class="topless"><a href="starting.html"
title="next chapter">Getting Started</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
......@@ -99,10 +99,10 @@
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="packages.html" title="Systems and Packages"
<a href="starting.html" title="Getting Started"
>next</a> |</li>
<li class="right" >
<a href="root.html" title="Welcome to Antik’s documentation!"
<a href="root.html" title="Antik"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="root.html">Antik 0 documentation</a> &raquo;</li>
</ul>
......
......@@ -26,7 +26,7 @@
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="Antik 0 documentation" href="root.html" />
<link rel="next" title="Elementary Mathematical Functions" href="elemmath.html" />
<link rel="prev" title="Introduction to Antik" href="intro.html" />
<link rel="prev" title="Getting Started" href="starting.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
......@@ -39,7 +39,7 @@
<a href="elemmath.html" title="Elementary Mathematical Functions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="intro.html" title="Introduction to Antik"
<a href="starting.html" title="Getting Started"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="root.html">Antik 0 documentation</a> &raquo;</li>
</ul>
......@@ -51,7 +51,7 @@
<div class="body" role="main">
<div class="section" id="systems-and-packages">
<h1>Systems and Packages<a class="headerlink" href="#systems-and-packages" title="Permalink to this headline"></a></h1>
<span id="systems-packages"></span><h1>Systems and Packages<a class="headerlink" href="#systems-and-packages" title="Permalink to this headline"></a></h1>
<p>There are several ASDF <a class="reference external" href="https://common-lisp.net/project/asdf/">systems</a> that can be loaded,</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">antik</span></code></li>
......@@ -78,8 +78,8 @@
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="intro.html"
title="previous chapter">Introduction to Antik</a></p>
<p class="topless"><a href="starting.html"
title="previous chapter">Getting Started</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="elemmath.html"
title="next chapter">Elementary Mathematical Functions</a></p>
......@@ -117,7 +117,7 @@
<a href="elemmath.html" title="Elementary Mathematical Functions"
>next</a> |</li>
<li class="right" >
<a href="intro.html" title="Introduction to Antik"
<a href="starting.html" title="Getting Started"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="root.html">Antik 0 documentation</a> &raquo;</li>
</ul>
......
......@@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to Antik’s documentation! &mdash; Antik 0 documentation</title>
<title>Antik &mdash; Antik 0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
......@@ -46,12 +46,13 @@
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome-to-antik-s-documentation">
<h1>Welcome to Antik&#8217;s documentation!<a class="headerlink" href="#welcome-to-antik-s-documentation" title="Permalink to this headline"></a></h1>
<div class="section" id="antik">
<h1>Antik<a class="headerlink" href="#antik" title="Permalink to this headline"></a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Antik</a></li>
<li class="toctree-l1"><a class="reference internal" href="starting.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="packages.html">Systems and Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="elemmath.html">Elementary Mathematical Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="utility.html">Utility</a></li>
......@@ -75,7 +76,7 @@
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to Antik&#8217;s documentation!</a></li>
<li><a class="reference internal" href="#">Antik</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
......
Search.setIndex({envversion:46,filenames:["elemmath","intro","packages","root","utility"],objects:{},objnames:{},objtypes:{},terms:{"default":0,"new":2,"return":4,"switch":1,aco:0,addit:[0,2],after:2,all:[2,4],alreadi:2,also:[1,2],answer:4,appli:4,arbitrari:0,arg:0,argument:0,arrai:2,asdf:2,asin:0,atan:0,avail:4,bar:1,base:[1,2],befin:2,befor:4,best:1,between:1,both:1,calcul:1,call:[0,1],can:[1,2],chang:1,charact:4,chosen:2,combin:1,common:[1,2,4],compar:1,comput:1,content:[3,4],conveni:2,convienc:2,cosh:0,creat:1,data:[1,2],decomposit:1,defin:2,definit:[2,4],den:0,design:1,develop:1,differen:1,dimens:2,discard:4,divis:0,divisor:0,each:2,easi:1,easili:1,element:4,encount:4,engin:1,enough:0,eof:4,eql:4,equival:0,exampl:1,except:2,exist:2,exp:0,expon:0,expt:0,facilit:1,featur:2,fill:4,floor:0,foo:1,foreign:[1,2],form:1,foundat:1,gener:[0,2],gnu:1,grid:[0,2],gsl:1,gsll:[1,2],index:3,initi:2,interchang:1,interfac:1,interoper:1,itself:4,kei:4,librari:1,like:1,lisp:[1,2],list:[2,4],load:2,mai:0,mainli:4,make:[1,2],matter:1,mean:1,minusp:0,mix:1,modul:3,more:1,most:2,multipl:0,name:[1,2],nicknam:2,nil:4,non:1,notabl:1,num:0,number:0,numer:1,object:1,onli:[1,4],option:[0,2],other:[0,1],packag:1,page:3,pass:1,permit:1,physic:2,plusp:0,post:4,prefix:1,problem:1,procedur:1,properli:2,provid:[0,1,4],quicklisp:2,reach:4,refer:2,regular:0,relat:2,rest:0,result:1,root:0,round:0,same:[1,2,4],satisfi:4,scienc:2,scientif:1,search:3,select:1,sever:2,shadow:2,should:[1,2,4],signum:0,simpl:1,sin:0,sinh:0,solv:1,some:2,someth:0,specifi:4,sqrt:0,squar:0,stop:4,stream:4,string:4,subtract:0,sure:2,symbol:2,system:1,tan:0,tanh:0,termin:4,test:4,than:0,thei:0,thi:1,two:2,updat:2,user:[1,2,4],util:3,valu:4,well:4,when:[0,4],whether:1,which:[2,4],whole:1,wish:1,without:1,zero:0,zerop:0},titles:["Elementary Mathematical Functions","Introduction to Antik","Systems and Packages","Welcome to Antik&#8217;s documentation!","Utility"],titleterms:{"function":0,antik:[1,3],document:3,elementari:0,indic:3,introduct:1,mathemat:0,packag:2,system:2,tabl:3,util:4,welcom:3}})
\ No newline at end of file
Search.setIndex({envversion:46,filenames:["elemmath","intro","packages","root","starting","utility"],objects:{},objnames:{},objtypes:{},terms:{"default":[0,4],"float":4,"new":2,"return":5,"switch":1,"true":4,aco:0,addit:[0,2],advis:4,after:2,all:[2,5],alreadi:2,also:[1,2,4],answer:5,appli:5,arbitrari:0,arg:0,argument:0,arrai:2,asdf:[2,4],asin:0,assert:4,atan:0,avail:5,bar:1,base:[1,2],befin:2,befor:5,begin:4,best:1,between:1,both:1,calcul:1,call:[0,1],can:[1,2,4],chang:1,charact:5,chosen:2,combin:1,common:[1,2,5],compar:1,comput:1,content:[3,5],conveni:[2,4],convienc:2,correctli:4,cosh:0,could:4,creat:1,current:4,data:[1,2],date:4,decomposit:1,defin:[2,4],definit:[2,4,5],den:0,design:1,detail:4,develop:1,differ:4,differen:1,dimens:[2,4],discard:5,divis:0,divisor:0,doubl:4,each:2,easi:1,easier:4,easili:1,element:5,enabl:4,encount:5,engin:1,enough:0,eof:5,eql:5,equival:0,error:4,exampl:[1,4],except:2,execut:4,exist:2,exp:0,expon:[0,4],expt:0,facilit:1,fail:4,featur:2,file:4,fill:5,first:4,floor:0,follow:4,foo:1,foreign:[1,2],form:[1,4],foundat:1,gener:[0,2],get:3,given:4,gnu:1,grid:[0,2,4],gsl:1,gsll:[1,2],index:3,initi:2,input:4,instal:4,interchang:1,interfac:1,interoper:1,interpret:4,itself:5,kei:5,leav:4,librari:1,like:1,line:4,lisp:[1,2,4],list:[2,5],liter:4,load:[2,4],macro:4,mai:[0,4],mainli:5,make:[1,2,4],manual:4,marker:4,matter:1,mean:1,minusp:0,miss:4,mix:1,modul:3,more:[1,4],most:2,multipl:0,name:[1,2,4],nicknam:2,nil:[4,5],non:1,normal:4,notabl:1,num:0,number:0,numer:1,object:1,onc:4,onli:[1,5],option:[0,2,4],other:[0,1],packag:1,page:3,pass:[1,4],permit:1,physic:[2,4],plusp:0,point:4,post:5,prefix:1,problem:1,procedur:1,prompt:4,properli:2,provid:[0,1,4,5],quantiti:4,quicklisp:[2,4],quickload:4,quot:4,reach:5,read:4,reader:4,readtabl:4,reassur:4,refer:2,regress:4,regular:0,relat:2,repl:4,rest:0,result:1,root:0,round:0,run:4,same:[1,2,5],satisfi:5,scienc:2,scientif:1,search:3,second:4,see:4,select:1,set:4,sever:2,shadow:2,should:[1,2,5],signum:0,simpl:1,sin:0,sinh:0,solv:1,some:2,someth:0,sourc:4,specifi:[4,5],sqrt:0,squar:0,start:3,stop:5,stream:5,string:5,subtract:0,summari:4,sure:2,symbol:2,system:1,tan:0,tanh:0,termin:5,test:[4,5],than:0,thei:0,thi:[1,4],three:4,time:4,total:4,two:2,type:4,unit:4,updat:2,user:[1,2,4,5],util:3,valu:5,well:5,when:[0,5],whether:1,which:[2,4,5],whole:1,wish:1,without:[1,4],work:4,your:4,zero:0,zerop:0},titles:["Elementary Mathematical Functions","Introduction to Antik","Systems and Packages","Antik","Getting Started","Utility"],titleterms:{"function":0,antik:[1,3],elementari:0,get:4,indic:3,introduct:1,mathemat:0,packag:2,start:4,system:2,tabl:3,util:5}})
\ No newline at end of file
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Getting Started &mdash; Antik 0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="Antik 0 documentation" href="root.html" />
<link rel="next" title="Systems and Packages" href="packages.html" />
<link rel="prev" title="Introduction to Antik" href="intro.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="packages.html" title="Systems and Packages"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="intro.html" title="Introduction to Antik"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="root.html">Antik 0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="getting-started">
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h1>
<p>Antik is normally installed using <a class="reference external" href="http://quicklisp.org/">Quicklisp</a>. Once Antik is loaded, it is advisable to set the default package to <code class="docutils literal"><span class="pre">ANTIK-USER</span></code> which is provided to make using Antik easier; see <a class="reference internal" href="packages.html#systems-packages"><span>Systems and Packages</span></a> for more details. Reader macros are defined by Antik for convenience in specifying physical dimension quantities, dates and times, and grids. These can be enabled with <code class="docutils literal"><span class="pre">set-reader</span></code>. This also sets the default floating point read type to <code class="docutils literal"><span class="pre">double-float</span></code>:</p>
<div class="highlight-lisp"><div class="highlight"><pre><span class="p">(</span><span class="nv">ql:quickload</span> <span class="ss">:antik</span><span class="p">)</span>
<span class="p">(</span><span class="nb">in-package</span> <span class="ss">:antik-user</span><span class="p">)</span>
<span class="p">(</span><span class="nv">set-reader</span><span class="p">)</span>
</pre></div>
</div>
<p>As a reassurance that the system is installed and working correctly, run the defined regression tests:</p>
<div class="highlight-lisp"><div class="highlight"><pre><span class="nb">&gt;</span> <span class="p">(</span><span class="nv">asdf:test-system</span> <span class="ss">:antik</span><span class="p">)</span>
<span class="nv">Unit</span> <span class="nv">Test</span> <span class="nv">Summary</span>
<span class="nv">| 93 assertions total</span>
<span class="nv"> |</span> <span class="mi">93</span> <span class="nv">passed</span>
<span class="nv">| 0 failed</span>
<span class="nv"> |</span> <span class="mi">0</span> <span class="nv">execution</span> <span class="nv">errors</span>
<span class="nv">| 0 missing tests</span>
<span class="nv"> Unit Test Summary</span>
<span class="nv"> |</span> <span class="mi">88</span> <span class="nv">assertions</span> <span class="nv">total</span>
<span class="nv">| 88 passed</span>
<span class="nv"> |</span> <span class="mi">0</span> <span class="nv">failed</span>
<span class="nv">| 0 execution errors</span>
<span class="nv"> |</span> <span class="mi">0</span> <span class="nv">missing</span> <span class="nv">tests</span>
<span class="no">T</span>
</pre></div>
</div>
<p>The first tests definitions in the <code class="docutils literal"><span class="pre">ANTIK</span></code> package and the second in the <code class="docutils literal"><span class="pre">GRID</span></code> package. In examples given in this manual, the <code class="docutils literal"><span class="pre">&gt;</span></code> at the begining of the line is the Lisp <a class="reference external" href="https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop">REPL</a> prompt, indicated the user-typed input follows. Your prompt may differ; for example, it could be the name of the current package, e.g. <code class="docutils literal"><span class="pre">ANTIK-USER&gt;</span></code>.</p>
<dl class="function">
<dt id="function:antik:set-reader">
<em class="property">function </em> (<code class="descname">set-reader</code> <em class="lambda_keyword text-muted">&amp;optional</em> (<em>readtable</em> <em>t</em>) (<em>default-float</em> (<em>quote</em> <em>double-float</em>)))<a class="headerlink" href="#function:antik:set-reader" title="Permalink to this definition"></a></dt>
<dd><p>If readtable is true, set the reader to enable the three Antik reader macros <code class="docutils literal"><span class="pre">#_</span></code> (physical dimension quantity), <code class="docutils literal"><span class="pre">#d</span></code> (date/time), <code class="docutils literal"><span class="pre">#m</span></code> (grid). Set the reader to interpret float literals without an exponent marker to be the type specified. If <code class="docutils literal"><span class="pre">NIL</span></code>, leave as-is.</p>
</dd></dl>
<dl class="macro">
<dt id="macro:antik:set-reader-in-file">
<em class="property">macro </em> (<code class="descname">set-reader-in-file</code> <em class="lambda_keyword text-muted">&amp;optional</em> (<em>readtable</em> <em>t</em>) (<em>default-float</em> (<em>quote</em> <em>double-float</em>)))<a class="headerlink" href="#macro:antik:set-reader-in-file" title="Permalink to this definition"></a></dt>
<dd><p>If readtable is true, set the reader to enable the three Antik reader macros <code class="docutils literal"><span class="pre">#_</span></code> (physical dimension quantity), <code class="docutils literal"><span class="pre">#d</span></code> (date/time), <code class="docutils literal"><span class="pre">#m</span></code> (grid). Set the reader to interpret float literals without an exponent marker to be the type specified. If <code class="docutils literal"><span class="pre">NIL</span></code>, leave as-is. Use this form in Lisp source files.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="intro.html"
title="previous chapter">Introduction to Antik</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="packages.html"
title="next chapter">Systems and Packages</a></p>