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