]> git.donarmstrong.com Git - neurodebian.git/blob - sphinx/index.rst
Point people to the actual paper.
[neurodebian.git] / sphinx / index.rst
1 .. _WELCOme:
2
3 ***********************************************
4  Welcome to the Debian Neuroscience Repository
5 ***********************************************
6
7 .. quotes::
8    :random: 1
9
10 This repository provides mostly neuroscience-related packages to be used on
11 Debian_ systems (or Debian-derivatives like Ubuntu_). It contains both unofficial
12 or prospective packages which are not (yet) available from the main Debian_
13 archive, as well as backported or simply rebuilt packages also available
14 elsewhere. Please see the :ref:`faq` for more information about the goals of
15 this project, and :ref:`read what people say about it <testimonials>`.
16 Take a look at the :ref:`list of our current and planned projects <projects>` if
17 you want to get involved. If you appreciate this service, please |spread|.
18
19 .. note::
20
21   This service is provided "as is". There is no guarantee that a package
22   works as expected, so use them at your own risk. If you encounter problems,
23   please `report <#contacts>`_ them.
24
25
26 .. raw:: html
27
28  <p>
29  <a href="pkgs.html"><img border="0" src="_static/package.png" title="Software package list" /></a>
30  <a href="pkglists/pkgs-by_release-datasets_(data).html"><img border="0" src="_static/datasets.png" title="Dataset package list" /></a>
31  <a href="vm.html"><img border="0" src="_static/machine.png" title="Get NeuroDebian for your non-Debian computer" /></a>
32  <a href="debian/pool"><img border="0" src="_static/pool.png" title="Go to the package pool (deep and cold, only for experts)" /></a>
33  <a href="projects.html"><img border="0" src="_static/workarea.png" title="Current and planned projects: Get involved!" /></a>
34  <a href="blog/index.html"><img border="0" src="_static/rssfeeds.png" title="NeuroDebian Insider Blog" /></a>
35  </p>
36
37 .. _Ubuntu: http://www.ubuntu.com
38
39 .. _news:
40
41 News
42 ====
43
44 .. raw:: html
45
46  <script src="_static/jquery.livetwitter.min.js"></script>
47  <div id="identica_widget"></div>
48  <script type="text/javascript">
49  $("#identica_widget").liveTwitter('neurodebian',
50                                    {service: 'identi.ca',
51                                     mode: 'user_timeline',
52                                     limit: 10,
53                                     rate: 300000});
54  </script>
55
56 For more news and information see our :ref:`blog <blog>`. Older news items are
57 available on identi.ca_. Follow us on identi.ca_ (preferred) or twitter_ to
58 subscribe to the NeuroDebian news.
59
60 .. _identi.ca: http://identi.ca/neurodebian
61 .. _twitter: http://twitter.com/NeuroDebian
62
63 .. _repository_howto:
64
65
66
67 How to use this repository
68 ==========================
69
70 To enable the NeuroDebian repository on your system, select your Debian or
71 Ubuntu release and a repository mirror from the lists below. Upon selection
72 a short command snippet will be displayed that can be copied and pasted into
73 a terminal session. These commands will configure the system package manager
74 with the NeuroDebian repository key and package source information.
75
76 .. include:: sources_lists
77
78 Once this is done, you have to update the package index and you are ready to
79 install packages. Use your favorite package manager, e.g. synaptic, adept. In
80 the terminal you can use :command:`apt-get`::
81
82   sudo apt-get update
83   sudo apt-get install mricron
84
85 .. note::
86
87   Not every package is available for all distributions/releases. For information
88   about which package version is available for which release and architecture,
89   please have a look at the corresponding package pages.
90
91
92 .. _chap_installation:
93
94 Ways to use NeuroDebian
95 =======================
96
97 Virtual machine
98 ---------------
99
100 If you are not running Debian_ on a particular machine a :ref:`chap_vm` is
101 provided as a convenient testing and evaluation environment.  After a few
102 simple steps to setup the virtual machine, you will be able to use NeuroDebian_
103 as an integral part of your existing working environment without any sacrifice.
104 The virtual machine is also a suitable environment to temporarily deploy
105 neuroscience software on machines running other operating systems, e.g. for the
106 purpose of teaching a neuroimaging data analysis course in a multipurpose
107 computer lab.
108
109
110 Debian installation
111 -------------------
112
113 Having been exposed to the wonders of NeuroDebian_ you are no longer
114 satisfied with your previous choice of operating system?  We would
115 recommend installing Debian_ to replace or complement (dual-boot) your
116 existing OS.  Please visit `"Getting Debian"
117 <http://www.debian.org/distrib/>`_ to obtain the images for your
118 hardware architecture and then simply add |repos|.
119
120
121 .. _chap_team:
122
123
124 The team
125 ========
126
127 Our main goal is to provide neuroscience FOSS_ for Debian_. Thus the
128 whole project would not be possible without the work of over 3,000
129 Debian_ developers and contributors who are as enthusiastically pursuing
130 a similar goal.  To add our share -- Debian_ packages of FOSS_ for
131 neuroscience research -- the `Experimental Psychology Debian packaging
132 project <http://alioth.debian.org/projects/pkg-exppsy>`_ was created
133 to formally join the forces of
134
135 * `Michael Hanke <http://mih.voxindeserto.de>`_
136 * `Yaroslav Halchenko <http://www.onerussian.com>`_
137
138 A number of packages that are now available from the NeuroDebian repository
139 were not packaged by our team, but similar Debian teams.  Therefore we want to
140 express particular gratitude to the `Debian Med`_ and `Debian Science`_ teams
141 for all their work.
142
143 .. _support:
144
145 Contacts
146 ========
147
148 `Email us directly <team@neuro.debian.net>`_ with any "private"
149 communication.  Otherwise please use our public mailing lists, which
150 exist not only to provide user-support but also to establish
151 communication channels within the NeuroDebian community
152
153 * neurodebian-users_: Discussions and support of NeuroDebian users
154
155 * neurodebian-upstream_: General discussions and knowledge sharing
156   among developers of the neuroscience software.  We will also use it
157   to update you with summaries of recent relevant developments in
158   Debian project
159
160 * neurodebian-devel_: Technical mailing list for discussions on
161   NeuroDebian development
162
163 You are welcome also to join #neurodebian IRC room on OFTC network if
164 you have quick questions or want to join a live discussion.
165
166 Acknowledgements
167 ================
168
169 We are grateful to `Jim Haxby`_ for his continued support and :ref:`endless supply of
170 Italian espresso <coffeeart>`.
171
172 .. _Jim Haxby: http://haxbylab.dartmouth.edu/ppl/jim.html
173
174 Thanks to the following institutions and individuals for hosting a mirror:
175
176 * `Department of Psychological and Brain Sciences at Dartmouth College`_
177   *[us-nh]* (primary mirror)
178 * `Department of Experimental Psychology at the University of Magdeburg`_
179   *[de]*
180 * `Neurobot at Aristotle University of Thessaloniki, Greece`_ *[gr]*
181 * `Paul Ivanov`_ *[us-ca]*
182 * `Medical-image Analysis and Statistical Interpretation lab at Vanderbilt`_
183   *[us-tn]*
184
185 If your are interested in mirroring the repository, please see the :ref:`faq`.
186
187 .. _Department of Psychological and Brain Sciences at Dartmouth College: http://www.dartmouth.edu/~psych
188 .. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de
189 .. _Neurobot at Aristotle University of Thessaloniki, Greece: http://neurobot.bio.auth.gr
190 .. _Paul Ivanov: http://www.pirsquared.org
191 .. _Medical-image Analysis and Statistical Interpretation lab at Vanderbilt: https://masi.vuse.vanderbilt.edu
192
193
194 Publications
195 ============
196
197 Hanke, M. & Halchenko, Y. O. (2011). `Neuroscience runs on GNU/Linux
198 <http://www.frontiersin.org/Neuroinformatics/10.3389/fninf.2011.00008/full>`_.
199 *Frontiers in Neuroinformatics, 5:8*.
200
201 Hanke, M., Halchenko, Y. O. & Haxby, J. V. (2011). `NeuroDebian -- versatile
202 platform for brain-imaging research <_files/NeuroDebian_HBM2011.png>`_
203 *Poster presented at the annual meeting of the Organisation for Human Brain
204 Mapping*, Quebec City, Canada.
205
206 Hanke, M. (2011). `Integrating Condor into the Debian operating system
207 <_files/Hanke_CondorDebianIntegration_CondorWeek2011.pdf>`_.
208 *Talk given at* `CondorWeek 2011
209 <http://www.cs.wisc.edu/condor/CondorWeek2011/wednesday_condor.html>`_,
210 Madison, Wisconsin, USA.
211
212 Hanke, M. & Halchenko, Y. O. (2010). :ref:`Report from the Debian booth at
213 SfN2010 <chap_debian_booth_sfn2010>`. *Annual meeting of the Society for
214 Neuroscience*, San Diego, USA.
215
216 Halchenko, Y. O., Hanke, M., Haxby, J. V., Pollmann, S. & Raizada, R. D.
217 (2010). `Having trouble getting your Nature paper? Maybe you are not using the
218 right tools? <_files/NeuroDebian_SfN2010.png>`_ *Poster presented at the
219 annual meeting of the Society for Neuroscience*, San Diego, USA.
220
221 Hanke, M., Halchenko, Y. O. (2010). `Debian: The ultimate platform for
222 neuroimaging research <_files/HankeHalchenko_NeuroDebianDebConf10.pdf>`_.
223 *Talk given at* DebConf10_, New York City, USA. [video:
224 `low resolution <http://meetings-archive.debian.net/pub/debian-meetings/2010/debconf10/low/1310_1310_Debian_The_ultimate_platform_for_neuroimaging_research.ogv>`_,
225 `high resolution <http://meetings-archive.debian.net/pub/debian-meetings/2010/debconf10/high/1310_1310_Debian_The_ultimate_platform_for_neuroimaging_research.ogv>`_]
226
227 Hanke, M., Halchenko, Y. O., Haxby, J. V. & Pollmann, S. (2010). `Improving
228 efficiency in cognitive neuroscience research with NeuroDebian
229 <_files/NeuroDebian_CNS2010.pdf>`_. *Poster presented at the annual
230 meeting of the Cognitive Neuroscience Society*, MontrĂ©al, Canada.
231
232 Halchenko, Y. O., Hanke, M. (2009). `An ecosystem of neuroimaging,
233 statistical learning, and open-source software to make research more
234 efficient, more open, and more fun
235 <_files/HalchenkoHanke_FossEcosystemDC09.pdf>`_. *Talk given at*
236 `Dartmouth College`_, New Hampshire, USA.
237
238 .. _DebConf10: http://debconf10.debconf.org/
239 .. _Dartmouth College: http://www.dartmouth.edu/
240
241
242 .. toctree::
243    :hidden:
244
245    blog/index
246    faq
247    pkgs
248    spread
249    vm
250    coffeeart
251    photoalbum
252    projects
253    testimonials
254
255 .. probably should be purged altogether
256 .. toctree::
257    :hidden:
258
259    booth_sfn2010
260    datasets
261    livecd
262    quotes-nihr01
263    quotes-nitrc
264    sources_lists
265    vm_welcome
266
267 .. include:: link_names.txt
268 .. include:: substitutions.txt