]> git.donarmstrong.com Git - neurodebian.git/commitdiff
first draft of the brochure -- needs distilling and some design TLC
authorYaroslav Halchenko <debian@onerussian.com>
Tue, 9 Nov 2010 06:11:29 +0000 (01:11 -0500)
committerYaroslav Halchenko <debian@onerussian.com>
Tue, 9 Nov 2010 06:11:29 +0000 (01:11 -0500)
artwork/brochure/Makefile
artwork/brochure/brochure_debian-neurodebian.tex

index 423456cddd9185d1a1133c23d505a774016cf6d6..92c0be3a541826748d0138fdacb5cac88b6e6c78 100644 (file)
@@ -1,7 +1,15 @@
-include LaTeX.mk
+# Unfortunately leads to the recursion
+#DEPENDS=pics
+
+# So just call 'make pics' first or whenever figures need to be
+# regenerated
 
-all:: pics
+include LaTeX.mk
 
 .PHONY: pics
 pics:
        @$(MAKE) -C ../ logo_tuned/label.pdf openlogo.pdf distro-dev.pdf
+
+# Can't be used as is since .gitignore would be searched for in this
+# directory
+# %.pdf: %.svg @$(MAKE) -f ../Makefile $@
index b64fed5d63a502395253918f9381f284f1fa3937..5c692626074a0b31864b6f91ee72c67b1728536f 100644 (file)
 }
 
 \usepackage{enumitem}           % useful for control of listings
+\usepackage[compact,raggedleft]{titlesec}
+\usepackage{comment}
+
+\newcommand{\epigraph}[3]{\textit{#1}\linebreak \vspace{-1.5em} \begin{flushright}\hspace{5em}\ --\ #2\linebreak\small{#3} \end{flushright}}
 
 \pagestyle{empty}
+\parindent=0pt
+
+% Attempts to change bg color of *section headings
+%\definecolor{secbgcol}{rgb}{0.9, 0.85, 0.85}
+%\titleformat{\section}
+%{\color{red}\normalfont\Large\bfseries}{\thesection}{1em}{}
+%\titleformat{\subsection}
+%{\color{red}\normalfont\large\bfseries}{\begin{flushright}\hfill\thesubsection
+%  \end{flushright}}{1em}{}
+%
+
 \begin{document}
 
 %%
 
 \begin{center}
 \noindent
-\includegraphics[width=0.5\columnwidth]{openlogo}
+%\includegraphics[width=0.5\columnwidth]{openlogo}
+\includegraphics[width=0.5\columnwidth]{openlogo-vsop}
 
 \url{http://www.debian.org}
-\section*{Debian GNU/Linux}
-\subsection*{The Universal Operating System}
+%\section*{Debian GNU/Linux}
+
+\section*{The Universal Operating System}
 \end{center}
+\noindent
+Debian project was founded by Ian Murdock in August 1993 with the goal
+to create an easy to install and maintain non-commercial GNU/Linux
+distribution that would be able to effectively compete in the
+commercial market.  Since then Debian established itself as an
+independent and unique project driven by more than 3,000 of
+enthusiastic Debian developers and contributors all around the globe.
+Principles of \emph{do-ocracy} and democracy backed up by evolving open
+standards allowed Debian to deliver the comprehensive operating system largest not
+only in its coverage of integrated software, but also in the
+number of the supported hardware architectures.
+% Current installer of Debian has been translated more that to 60 languages.
+% (12 ???  officially supported architectures).
+% Well appreciated
+Acknowledged quality and openness of Debian made it the choice for
+more than 120 derivative GNU/Linux distributions, such as Ubuntu and
+Mint.
+
+\subsection*{Debian is}
+\begin{description}[nolistsep,leftmargin=0.8em,style=nextline]
+\item[V\textnormal{ersatile}] Over 15,000 software products maintained to provide
+  a secure and stable system for any field of application
+  (\url{http://packages.debian.org})
+%\item[S]ecure
+%\item[S]table
+\item[S\textnormal{imple}] Single command is enough to install or upgrade single
+  software or the entire system at once
+\item[O\textnormal{pen}] All software is free and open-source (FOSS).\\
+  Debian project decisions are voted for in public
+\item[P\textnormal{opular}] Used by governments, companies, education
+  institutions (\url{http://www.debian.org/users/})
+\end{description}
+
+\begin{comment}
+Original: Very Special Old Pale
+
+Could also stand for
+Very (Special|Stable) Operating Platform
+\end{comment}
+
+%\section*{Understand Debian}
+
+\subsection*{Debian suites}
+
+% Debian distribution comes in 3 major flavors
+
+\begin{description}[nolistsep,leftmargin=1pc,topsep=1em]
+
+%\item[Unstable] \emph{Constantly changing distribution}\\
+\item[Development]\hfill\emph{Unstable} (always \emph{sid})\\
+  Never \emph{released}, constantly evolving platform to integrate new
+  versions of software in Debian.\\
+  %entry point for the software to appear in Debian.\\
+  Despite its name, \emph{Unstable} is a good platform for those
+  requiring the most recent versions of software
+
+%\item[Testing] \emph{Constantly changing future release candidate}\\
+\item[``Always-ready-to-release'']  \emph{Testing} (now \emph{squeeze})\\
+%  What to become a next \emph{Stable} release candidate.\\
+  Software migrated from \emph{Unstable} which is known to be of good
+  quality.  Immediate updates are provided only
+  to assure secure and robust performance. \\
+  \emph{Testing} provides a good balance between stability and recency
+  of software
+
+%\item[Stable] \emph{Official release}\\
+\item[Official release]\hfill\emph{Stable} (now \emph{lenny})\\
+  Software verified to be well tested and secure,
+  % Very stable (hence the name) and secure
+  but might be lacking the most recent versions.\\% of the software.\\
+  % of not the most recent versions. \\
+  \emph{Stable} is released based on \emph{Testing} ``when it is
+  ready'', on average bi-yearly.  Complementary updates keep the
+  system secure and robust.\\
+  \emph{Stable} is the choice where robustness and security are of
+  primary importance.
+\end{description}
+
+\begin{comment}
+\subsection*{It has names}
+
+The code names of Debian releases are names of characters from the Toy
+Story animation, e.g. sid, squeeze, lenny.  \emph{Unstable}
+flavor always called \emph{sid}, while a new name chosen for every
+upcoming release and assigned to \emph{Testing} to become a code name
+of the release when it becomes \emph{Stable}.\\  At the moment
+\emph{squeeze} is \emph{Testing}, and \emph{lenny} is \emph{Stable}.
+As soon as \emph{squeeze} gets released, \emph{Testing} will be given
+a new name -- \emph{wheezy}.
+\end{comment}
+
+\subsection*{Debian components}
+
+% Debian distribution comes in 3 major flavors
+%Debian Free Software Guidelines (DFSG)\\
+%\url{http://www.debian.org/social_contract}
+
+\begin{description}[nolistsep,leftmargin=1pc,topsep=1em]
+\item[Free as in freedom]\hfill\emph{main}\\
+  This is the actual Debian with full support.\\
+  All software in \emph{main} is distributed under FOSS licenses
+  compliant with Debian Free Software Guidelines (DFSG) to assure
+  complete freedom to use, modify, and (re-)distribute
+\item[Not free \emph{en bloc}]\hfill\emph{contrib}\\
+  Software which, despite being free itself, depends on
+  \emph{non-free} 3rd party software, rendering it useless without
+\item[Somewhat free]\hfill\emph{non-free}\\
+  Software which is under a restrictive license removing some freedoms
+  (\emph{e.g.} non-commercial use only), but which is allowed to be
+  used for free and re-distributed (\emph{e.g. NVidia drivers})
+\end{description}
+
+
+\subsection*{Debian is driven by enthusiastic experts}
+% could be simply 'Debian People' or 'Debian Community'
+
+Debian is the only major Linux distribution that is being developed
+cooperatively solely by many individuals through the Internet, in the
+same spirit as Linux and other free software.\\
+The Debian developers, teams and the community contribute to the
+project not by writing new applications (in most cases), but by
+\begin{itemize}[nolistsep,leftmargin=1pc]
+\item packaging existing software into Debian
+  according to the open standards of the project
+\item assuring quality of the overall Debian distribution
+\item fixing and communicating bug reports to upstream developers
+\item improving documentation and internationalization
+\item providing user support
+\end{itemize}
 
+Packaged software in Debian have individual maintainers which are
+often also the users of that software, so they are interested to have
+it functioning correctly.  Often individual maintainers join
+the teams, such as Debian-Science or Debian-Med, based on the common
+field of interest.
+
+%\columnbreak
+\subsection*{HOWTO get Debian}
+
+%\subsubsection*{Stable}
+\begin{description}[nolistsep,leftmargin=1pc,style=nextline]
+\item[Install on a hard-drive] \url{http://get.debian.net/}
+\item[Boot from CD/USB] \url{http://get.debian.net/live/}
+\item[Run in a Virtual Machine] \url{http://neuro.debian.net/vm.html}
+\item[More options (e.g. buy pre-installed)] \url{http://debian.org/distrib}
+\item[Testing/Unstable version] \url{http://www.debian.org/devel/debian-installer}
+\end{description}
+
+% \subsection*{Get \emph{Testing/Unstable} Debian}
+%
+% Install on a hard-drive or in a Virtual Machine\\
+% \url{http://www.debian.org/devel/debian-installer}
+%
+
+\subsection*{HOWTO install software X}
+
+\begin{description}[nolistsep,leftmargin=1pc,style=nextline]
+
+\item[GUI (Synaptic Package Manager)]
+%  \emph{Synaptic Package Manager}
+  Select X and click ``Apply''\\
+  \includegraphics[width=0.95\columnwidth]{shots/synaptic-fslview}
+\item[Command line]
+  apt-get install X
+\end{description}
+
+
+
+\subsection*{HOWTO upgrade the entire system}
+
+\begin{description}[nolistsep,leftmargin=1pc,style=nextline]
+\item[GUI (Synaptic Package Manager)]
+  Click ``Mark All Upgrades'', ``Apply''
+\item[Command line]
+  apt-get update; apt-get dist-upgrade
+\end{description}
+
+\subsection*{HOWTO get support}
+
+\url{http://www.debian.org/support}
+
+\begin{description}[nolistsep,leftmargin=1pc,style=nextline]
+%\item[GUI]
+%  Use \emph{Synaptic Package Manager}
+\item[Software bug]
+  reportbug X
+\item[Community support]
+  %\begin{description}[nolistsep,leftmargin=1pc]
+  %\item[Mailing lists] 
+  \url{http://www.debian.org/MailingLists}\\
+  \url{http://forums.debian.net}\\
+  \url{http://ask.debian.net}
+  %\end{description}
+\item[Commercial support]
+  \url{http://www.debian.org/consultants}
+\end{description}
+
+\begin{comment}
 \section*{Reasons to choose Debian}
 \paragraph{It is maintained by its users}
+
 If something needs to be fixed or improved, we just do it.
 
 \paragraph{Unparalleled support}
@@ -119,8 +334,8 @@ to submit bug reports and are notified when and why the bug was closed. This
 system allows Debian to respond to problems quickly and honestly.
 
 
-
 \section*{Acknowledgements}
+\end{comment}
 
 \end{multicols}
 
@@ -137,33 +352,103 @@ system allows Debian to respond to problems quickly and honestly.
 \includegraphics[width=\columnwidth]{logo_tuned/label}
 
 \url{http://neuro.debian.net}
-\section*{NeuroDebian Project}
-\subsection*{The Universal Research Environment}
-
+%\section*{NeuroDebian Project:}
+\section*{The Ultimate Research Platform}
 
 \end{center}
 
-\section*{What is NeuroDebian}
+\section*{NeuroDebian is}
+
+a Debian project aiming to provide Neuroscience community with a
+stable and versatile research platform -- the Debian OS.  NeuroDebian
+(formerly known as Experimental Psychology, ExpPsy) was initiated in
+2006 to provide packaging of PyEPL and FSL software so they could
+become an integral part of Debian, thus seamlessly available to users
+of Debian or any derived distribution.  Since 2006 software coverage
+of NeuroDebian increased more than ten-fold.  NeuroDebian repository
+\url{http://neuro.debian.net} makes recent versions of the software
+available not only for the \emph{Development} but also for previous
+releases of Debian and Ubuntu.  The tandem of a stable generic
+operating system, Debian, together with new versions of research
+software from NeuroDebian repository compose the ultimate research
+platform -- stable versatile environment with recent neuroscientific
+methodologies just 1-click away.  Such stability, ease of software
+installation and system maintenance and constantly growing coverage of
+software solutions made NeuroDebian project popular among
+neuroscientists and scientific software developers.
+
+
+\section*{NeuroDebian is NOT}
+
+a yet another Debian GNU/Linux derivative distribution.  All work done
+within NeuroDebian project targets software inclusion in the official
+Debian distribution.
+
+
+\section*{Advantages from integration into Debian}
+
+\begin{itemize}[nolistsep,leftmargin=1pc]
+
+% rephrase to outline the benefit, not burden
+\item Debian standards and policies guaranty quality and robustness
+
+\item Debian centralized bug tracking system provides a unified
+  single-point of entry for bug reporting and troubleshooting for any
+  software in Debian
+
+\item Debian makes software available within world-wide distribution
+  network, thus offloading bandwidth demands
+
+\item Other Debian enthusiasts take care about large-scale aspects of
+  deployment, quality assurance, porting and integration at the level
+  of the entire distribution:
+
+\begin{description}[nolistsep,leftmargin=1pc]
+\item[Porting] Software sources get built for 11 hardware
+  architectures and 3 kernels (Linux, HURD, kFreeBSD). Ports teams
+  maintain build infrastructure and help making the code
+  platform-agnostic.
+\item[QA] Whole-archive rebuilds assure robustness of packaging and
+  warn about upcoming problems (core libraries upgrades) beforehand.
+\item[Internationalization (I18n)] I18n teams contribute by localizing
+  software for more than 50 languages
+\end{description}
 
-\section*{What is in NeuroDebian}
+\item Neuroscience software becomes 1st-class citizen within Debian
+  project, which guarantees its availability, longevity, smooth
+  installation and upgrades
 
-Icons for FSL, Caret, AFNI, etc
+\item Participation in the Debian community helps to assure Debian's
+  aptness for the neuroscientific software demands
 
+\end{itemize}
 
-%\columnbreak
 
-\section*{How to get NeuroDebian}
+\section*{NeuroDebian coverage}
+\begin{flushright}
+\vspace{-0.5em}
+\url{http://neuro.debian.net/pkgs.html}
+\vspace{-1em}
+\end{flushright}
+\begin{description}[nolistsep,leftmargin=1pc,topsep=0em]
+\item[Electrophysiology] BioSig, Sigviewer, Brian, \ldots
+\item[Machine Learning] PyMVPA, scikits.learn, \ldots
+\item[Medical Imaging] AFNI, Caret, FSL, Mricron, NiPy, Voxbo, \ldots
+\item[Psychophysics] PsychoPy, PyEPL
+\end{description}
 
-\begin{itemize}
-\item Debian/Ubuntu -- Repository
-\item Others -- Virtual Appliance
-\end{itemize}
 
-\section*{Developers oriented information}
 
-buga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga duga
-sdflkj
-slkdjf
+%\columnbreak
+
+\section*{HOWTO get NeuroDebian}
+\begin{description}[nolistsep,leftmargin=1pc]
+\item[Debian/Ubuntu]\url{neuro.debian.net} repository
+\item[Others] NeuroDebian Virtual Machine
+% Here place a left-top corner of OSX with seamless mode
+\end{description}
+\begin{comment}
+\section*{Developers oriented information}
 
 %\columnbreak
 
@@ -173,42 +458,62 @@ slkdjf
 %\includegraphics[width=\columnwidth]{usage_worldmap}
 
 buga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga dugabuga duga
-
-
-\section*{Future\ldots}
-
-\begin{description}[leftmargin=1em]
-
-\item[Wider coverage]:\\
-  BioSig, NEURON, FreeSurfer, etc.
-
-\item[Assured interoperability]:\\
-  Intergration- and regression- testing
-
-\item[Snapshotting]
-
-\item[Data as 1st class citizen]
-
-\item[Universal Availability]:\\
-  \begin{itemize}
-  \item New versions of Virtual Appliance
-  \item Cloud computing images
-  \end{itemize}
+\end{comment}
+
+\def\blank{\hspace{0em}\vspace{-1em}}
+\columnbreak
+\section*{Work-in-progress}
+
+\begin{description}[nolistsep,leftmargin=1pc,topsep=1em,style=nextline]
+
+\item[Expanded coverage]\blank
+  \begin{description}[nolistsep,leftmargin=1pc,topsep=0em,style=nextline]
+  \item[Electrophysiology] BioSig, Brian, NEURON, \ldots
+  \item[Matlab/Octave toolboxes] SPM, EEGLAB, \ldots
+  \end{description}
+\vspace{0.5em}
+\epigraph{Having FreeSurfer integrated into the Debian operating system by the NeuroDebian team would have enormous benefits for us, and for the thousands of users of FreeSurfer across the world.}{Prof. Bruce Fischl}{Director, Computational Core at Martinos Center at Massachusetts General Hospital, Charlestown, Massachusetts, USA}
+\item[Improved quality assurance]
+  Extended integration and regression testing
+\item[Available snapshotting service]
+  % Entire NeuroDebian repository for any given past moment
+  All versions of packages readily available
+\item[Data as the 1st class citizen]
+  \url{http://neuro.debian.net/datasets.html}
+\item[Universal availability]\blank
+  % \begin{itemize}[nolistsep,leftmargin=1pc,topsep=0em]
+  % \item Virtual Appliance enhancements
+  %\item
+  Cloud computing
+  %\end{itemize}
 
 \end{description}
 
 
-\section*{Endorsements}
+\section*{Testimonials}
+\begin{flushright}
+\vspace{-0.5em}
+\url{http://neuro.debian.net/testimonials.html}
+\vspace{-1em}
+\end{flushright}
 
-some quotes from letters of support
 
+\epigraph{The approach taken with NeuroDebian is plainly the most appropriate
+approach to software distribution for the dominant platform in brain
+image analysis, and I have great confidence that this project will be
+a major asset to the neuroscience community in facilitating the
+distribution of stable software, improving the reliability and
+replicability of analyses, and in helping to improve software
+development practices.}{Prof. Daniel Y. Kimberg}{Director, Data
+Processing Facility, Center for Functional Neuroimaging, University of
+Pennsylvania, Philadelphia, USA}
 
 \section*{Acknowledgements}
 
 We are grateful to all Debian developers and contributors for the
-development of Debian OS, and to Prof. Jim Haxby (PBS Department,
+development of Debian OS, and to Prof. James V. Haxby (PBS Department,
 Dartmouth College) for his continued support and endless supply of
-Italian espresso.
+Italian espresso (\url{http://neuro.debian.net/coffeeart.html}).
 
 %\columnbreak
 \end{multicols}