]> git.donarmstrong.com Git - neurodebian.git/blob - sphinx/index.rst
Save some space on the frontpage.
[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="feeds/blog.xml"><img border="0" src="_static/rssfeeds.png" title="NeuroDebian Insider feed" /></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 Older news items are available on identi.ca_. Follow us on identi.ca_
57 (preferred) or twitter_ to subscribe to the NeuroDebian news.
58
59 .. _identi.ca: http://identi.ca/neurodebian
60 .. _twitter: http://twitter.com/NeuroDebian
61
62 .. _repository_howto:
63
64
65
66 How to use this repository
67 ==========================
68
69 To enable the NeuroDebian repository on your system, select your Debian or
70 Ubuntu release and a repository mirror from the lists below. Upon selection
71 a short command snippet will be displayed that can be copied and pasted into
72 a terminal session. These commands will configure the system package manager
73 with the NeuroDebian repository key and package source information.
74
75 .. include:: sources_lists
76
77 Once this is done, you have to update the package index and you are ready to
78 install packages. Use your favorite package manager, e.g. synaptic, adept. In
79 the terminal you can use :command:`apt-get`::
80
81   sudo apt-get update
82   sudo apt-get install mricron
83
84 .. note::
85
86   Not every package is available for all distributions/releases. For information
87   about which package version is available for which release and architecture,
88   please have a look at the corresponding package pages.
89
90
91 .. _chap_installation:
92
93 Ways to use NeuroDebian
94 =======================
95
96 Virtual machine
97 ---------------
98
99 If you are not running Debian_ on a particular machine a :ref:`chap_vm` is
100 provided as a convenient testing and evaluation environment.  After a few
101 simple steps to setup the virtual machine, you will be able to use NeuroDebian_
102 as an integral part of your existing working environment without any sacrifice.
103 The virtual machine is also a suitable environment to temporarily deploy
104 neuroscience software on machines running other operating systems, e.g. for the
105 purpose of teaching a neuroimaging data analysis course in a multipurpose
106 computer lab.
107
108
109 Debian installation
110 -------------------
111
112 Having been exposed to the wonders of NeuroDebian_ you are no longer
113 satisfied with your previous choice of operating system?  We would
114 recommend installing Debian_ to replace or complement (dual-boot) your
115 existing OS.  Please visit `"Getting Debian"
116 <http://www.debian.org/distrib/>`_ to obtain the images for your
117 hardware architecture and then simply add |repos|.
118
119
120 .. _chap_team:
121
122
123 The team
124 ========
125
126 Our main goal is to provide neuroscience FOSS_ for Debian_. Thus the
127 whole project would not be possible without the work of over 3,000
128 Debian_ developers and contributors who are as enthusiastically pursuing
129 a similar goal.  To add our share -- Debian_ packages of FOSS_ for
130 neuroscience research -- the `Experimental Psychology Debian packaging
131 project <http://alioth.debian.org/projects/pkg-exppsy>`_ was created
132 to formally join the forces of
133
134 * `Michael Hanke <http://mih.voxindeserto.de>`_
135 * `Yaroslav Halchenko <http://www.onerussian.com>`_
136
137 A number of packages that are now available from the NeuroDebian repository
138 were not packaged by our team, but similar Debian teams.  Therefore we want to
139 express particular gratitude to the `Debian Med`_ and `Debian Science`_ teams
140 for all their work.
141
142 .. _support:
143
144 Contacts
145 ========
146
147 `Email us directly <team@neuro.debian.net>`_ with any "private"
148 communication.  Otherwise please use our public mailing lists, which
149 exist not only to provide user-support but also to establish
150 communication channels within the NeuroDebian community
151
152 * neurodebian-users_: Discussions and support of NeuroDebian users
153
154 * neurodebian-upstream_: General discussions and knowledge sharing
155   among developers of the neuroscience software.  We will also use it
156   to update you with summaries of recent relevant developments in
157   Debian project
158
159 * neurodebian-devel_: Technical mailing list for discussions on
160   NeuroDebian development
161
162
163 Acknowledgements
164 ================
165
166 We are grateful to `Jim Haxby`_ for his continued support and :ref:`endless supply of
167 Italian espresso <coffeeart>`.
168
169 .. _Jim Haxby: http://haxbylab.dartmouth.edu/ppl/jim.html
170
171 Thanks to the following institutions and individuals for hosting a mirror:
172
173 * `Department of Psychological and Brain Sciences at Dartmouth College`_
174   *[us-nh]* (primary mirror)
175 * `Department of Experimental Psychology at the University of Magdeburg`_
176   *[de]*
177 * `Neurobot at Aristotle University of Thessaloniki, Greece`_ *[gr]*
178 * `Paul Ivanov`_ *[us-ca]*
179 * `Medical-image Analysis and Statistical Interpretation lab at Vanderbilt`_
180   *[us-tn]*
181
182 If your are interested in mirroring the repository, please see the :ref:`faq`.
183
184 .. _Department of Psychological and Brain Sciences at Dartmouth College: http://www.dartmouth.edu/~psych
185 .. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de
186 .. _Neurobot at Aristotle University of Thessaloniki, Greece: http://neurobot.bio.auth.gr
187 .. _Paul Ivanov: http://www.pirsquared.org
188 .. _Medical-image Analysis and Statistical Interpretation lab at Vanderbilt: https://masi.vuse.vanderbilt.edu
189
190
191 Publications
192 ============
193
194 Hanke, M. & Halchenko, Y. O. (2010). :ref:`Report from the Debian booth at
195 SfN2010 <chap_debian_booth_sfn2010>`. *Annual meeting of the Society for
196 Neuroscience*, San Diego, USA.
197
198 Halchenko, Y. O., Hanke, M., Haxby, J. V., Pollmann, S. & Raizada, R. D.
199 (2010). `Having trouble getting your Nature paper? Maybe you are not using the
200 right tools? <_files/NeuroDebian_SfN2010.png>`_ *Poster to be presented at the
201 annual meeting of the Society for Neuroscience*, San Diego, USA.
202
203 Hanke, M., Halchenko, Y. O. (2010). `Debian: The ultimate platform for
204 neuroimaging research <_files/HankeHalchenko_NeuroDebianDebConf10.pdf>`_.
205 *Talk given at* DebConf10_, New York City, USA. [video:
206 `low resolution <http://meetings-archive.debian.net/pub/debian-meetings/2010/debconf10/low/1310_1310_Debian_The_ultimate_platform_for_neuroimaging_research.ogv>`_,
207 `high resolution <http://meetings-archive.debian.net/pub/debian-meetings/2010/debconf10/high/1310_1310_Debian_The_ultimate_platform_for_neuroimaging_research.ogv>`_]
208
209 Hanke, M., Halchenko, Y. O., Haxby, J. V. & Pollmann, S. (2010). `Improving
210 efficiency in cognitive neuroscience research with NeuroDebian
211 <_files/NeuroDebian_CNS2010.pdf>`_. *Poster presented at the annual
212 meeting of the Cognitive Neuroscience Society*, MontrĂ©al, Canada.
213
214 Halchenko, Y. O., Hanke, M. (2009). `An ecosystem of neuroimaging,
215 statistical learning, and open-source software to make research more
216 efficient, more open, and more fun
217 <_files/HalchenkoHanke_FossEcosystemDC09.pdf>`_. *Talk given at*
218 `Dartmouth College`_, New Hampshire, USA.
219
220 .. _DebConf10: http://debconf10.debconf.org/
221 .. _Dartmouth College: http://www.dartmouth.edu/
222
223
224 .. toctree::
225    :hidden:
226
227    faq
228    pkgs
229    spread
230    vm
231    coffeeart
232    photoalbum
233    projects
234    testimonials
235
236 .. probably should be purged altogether
237 .. toctree::
238    :hidden:
239
240    booth_sfn2010
241    datasets
242    livecd
243    quotes-nihr01
244    quotes-nitrc
245    sources_lists
246    vm_welcome
247
248 .. include:: link_names.txt
249 .. include:: substitutions.txt