From 757aeb085927ba8f388b53565f87497c8fcc3be4 Mon Sep 17 00:00:00 2001 From: AJ Rossini Date: Thu, 4 Oct 2012 02:32:22 +0200 Subject: [PATCH] documentation cleanup, to fast forward to current practices. Signed-off-by: AJ Rossini --- README.org | 63 +++++++++++++++++--------------------- TODO.org | 5 +-- src/data/dataframe-listoflist.lisp | 10 +++--- 3 files changed, 36 insertions(+), 42 deletions(-) diff --git a/README.org b/README.org index 94e2353..b264e3d 100644 --- a/README.org +++ b/README.org @@ -1,5 +1,5 @@ -Time-stamp: <2012-07-12 18:36:03 tony> +Time-stamp: <2012-10-04 02:30:43 tony> * Fast Start @@ -17,40 +17,33 @@ Time-stamp: <2012-07-12 18:36:03 tony> (ql:quickload :cls) #+end_src -** TODO set up git submodules to do the right thing. - - State "TODO" from "" [2010-10-10 Sun 23:30] - -#+begin_src shell - git submodules init - git submodules update -#+end_src - - to get the whole package. - -** Build shared library - - *_Obsolete_*: Make the shared library liblispstat with an ANSI C - compiler (only gcc tested at this point). This is used for - numerical support which might be more robust to obtain from GSLL or - similar other systems. It would be done via. - -#+begin_src shell - cd lib && make && cd -#+end_src - - run a common lisp (SBCL, CMUCL, CLISP, CLOZURE-CL) starting in the - current directory. Recent versions of CFFI and LIFT can be found in - the external/ subdirectory, and should be autoload-able, assuming - that you are using a Lisp implementation supporting ASDF. - (AJR-FIXME: need to upload my GIT mirrors to repo.or.cz or similar, - and have them potentially available as submodules if needed) - - (on Debian or similar systems: can use CLC (Common Lisp Controller) - or SBCL approaches, i.e. ~/.clc/systems or ~/.sbcl/systems should - contain softlinks to the cls, cffi, and lift ASDF files - (i.e. cls.asd, cffi.asd, and lift.asd). AJR-FIXME: There is - probably a similar incantation for other CL's, need to record that - here!). + At one point, I planned on git-delivery via submodules, but this + proved to be a bit more complex than needed, thanks to the creation + of quicklisp. + + There will need to be a version for delivering a development QL + environment (for development) and this will consist of git + repositories, possibly through submodules, but this is for + discussion. + + There are quite a few libraries that are needed, and right now we + are working on simplifying the whole thing. Once you get past + this step, then you should: + + 1. run a common lisp (SBCL, CMUCL, CLISP, CLOZURE-CL) starting in + the current directory. Recent versions of CFFI and LIFT can be + found in the external/ subdirectory, and should be autoload-able, + assuming that you are using a Lisp implementation supporting + ASDF. (AJR-FIXME: need to upload my GIT mirrors to repo.or.cz or + similar, and have them potentially available as submodules if + needed) + + 2. (on Debian or similar systems: can use CLC (Common Lisp + Controller) or SBCL approaches, i.e. ~/.clc/systems or + ~/.sbcl/systems should contain softlinks to the cls, cffi, and + lift ASDF files (i.e. cls.asd, cffi.asd, and lift.asd). + AJR-FIXME: There is probably a similar incantation for other + CL's, need to record that here!). Step through ls-demo.lisp for a range of examples of activities. diff --git a/TODO.org b/TODO.org index 00eb8d8..a1dd19c 100644 --- a/TODO.org +++ b/TODO.org @@ -1,5 +1,5 @@ -Time-stamp: <2012-07-01 11:14:12 tony> +Time-stamp: <2012-10-04 02:31:38 tony> Creation: <2008-09-08 08:06:30 tony> * Intro and Metadata @@ -18,7 +18,7 @@ What is this talk of 'release'? Klingons do not make software 'releases'. Our software 'escapes', leaving a bloody trail of designers and quality assurance people in its wake. -* Design +* Design Documentation ** (Internal) Package and (External) System Hierarchy *** Singletons (primary building blocks) @@ -62,6 +62,7 @@ designers and quality assurance people in its wake. ?? cl-plplot : cffi + * Tasks to Do [4/25] Usually, we need to load it before going on. diff --git a/src/data/dataframe-listoflist.lisp b/src/data/dataframe-listoflist.lisp index 5ca6b40..6e6f254 100644 --- a/src/data/dataframe-listoflist.lisp +++ b/src/data/dataframe-listoflist.lisp @@ -1,6 +1,6 @@ ;;; -*- mode: lisp -*- -;;; Time-stamp: <2009-09-21 17:03:03 tony> +;;; Time-stamp: <2012-07-01 12:02:55 tony> ;;; Creation: <2009-03-12 17:14:56 tony> ;;; File: dataframe-listoflist.lisp ;;; Author: AJ Rossini @@ -30,8 +30,8 @@ :accessor dataset :documentation "Data storage: typed as matrix-like (numerical only).")) - (:documentation "example implementation of dataframe-like using storage - based on lisp-matrix structures.")) + (:documentation "example implementation of dataframe-like using + storage based on lisp-matrix structures.")) (defmethod nrows ((df dataframe-listoflist)) "specializes on inheritance from listoflist in lisp-matrix." @@ -42,8 +42,8 @@ (length (elt (dataset df) 0))) (defmethod xref ((df dataframe-listoflist) &rest subscripts) - "Returns a scalar in array, in the same vein as aref, mref, vref, etc. -idx1/2 is row/col or case/var." + "Returns a scalar in array, in the same vein as aref, mref, vref, +etc. idx1/2 is row/col or case/var." (elt (elt (dataset df) (elt subscripts 0)) (elt subscripts 1))) ;; ?? (defmethod (setf xref) (value (df dataframe-listoflist) &rest subscripts) -- 2.11.4.GIT