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 The easiest way to use this repository is to download an APT-configuration file
  91 (`sources.list`). Simply choose your target distribution/release and download
  92 the configuration for a mirror close to you (depending on your browser, you
  93 might have to right-click and choose 'save as'). Once downloaded, put the file
  94 in the `/etc/apt/sources.list.d/` directory on your system. Moving files in
  95 this directory will require superuser privileges, therefore you should probably
  96 download the file into a temporary directory and subsequently move it into
  97 `/etc/apt/sources.list.d/`. APT-configurations are available for the following
  98 releases and repository mirrors:
  99
 100 .. include:: sources_lists
 101
 102 .. note::
 103   Thanks to the following institutions and individuals for hosting a mirror:
 104
 105   * `Department of Psychological and Brain Sciences at Dartmouth College`_
 106     *[us-nh]* (primary mirror)
 107   * `Department of Experimental Psychology at the University of Magdeburg`_
 108     *[de]*
 109   * `Neurobot at Aristotle University of Thessaloniki, Greece`_ *[gr]*
 110   * `Paul Ivanov`_ *[us-ca]*
 111   * `Medical-image Analysis and Statistical Interpretation lab at Vanderbilt`_
 112     *[us-tn]*
 113
 114   If your are interested in mirroring the repository, please see the :ref:`faq`.
 115
 116 .. _Department of Psychological and Brain Sciences at Dartmouth College: http://www.dartmouth.edu/~psych
 117 .. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de
 118 .. _Neurobot at Aristotle University of Thessaloniki, Greece: http://neurobot.bio.auth.gr
 119 .. _Paul Ivanov: http://www.pirsquared.org
 120 .. _Medical-image Analysis and Statistical Interpretation lab at Vanderbilt: https://masi.vuse.vanderbilt.edu
 121
 122 Once this is done, you have to update the package index. Use your favorite
 123 package manager, e.g. synaptic, adept, or whatever you like. In the terminal
 124 you can use :command:`aptitude` to achieve the same::
 125
 126   sudo aptitude update
 127
 128 Now, you can proceed to install packages, e.g.::
 129
 130   sudo aptitude install lipsia
 131
 132 .. note::
 133   Not every package is available for all distributions/releases. For information
 134   about which package version is available for which release and architecture,
 135   please have a look at the corresponding package pages.
 136
 137 After this initial setup you probably also want to configure your package
 138 manager to recognize the NeuroDebian archive key. With this key the package
 139 manager can verify that packages haven't been modified and are identical with
 140 the ones in the main NeuroDebian archive, regardless of which mirror you
 141 downloaded them from. The NeuroDebian key id is **2649A5A9**. If you need further
 142 help setting up package authentication, please take a look at
 143 :ref:`corresponding FAQ <sec_pkg_authentication>`.
 144
 145
 146 .. _chap_installation:
 147
 148 Ways to use NeuroDebian
 149 =======================
 150
 151 Virtual machine
 152 ---------------
 153
 154 If you are not running Debian_ on a particular machine a :ref:`chap_vm` is
 155 provided as a convenient testing and evaluation environment.  After a few
 156 simple steps to setup the virtual machine, you will be able to use NeuroDebian_
 157 as an integral part of your existing working environment without any sacrifice.
 158 The virtual machine is also a suitable environment to temporarily deploy
 159 neuroscience software on machines running other operating systems, e.g. for the
 160 purpose of teaching a neuroimaging data analysis course in a multipurpose
 161 computer lab.
 162
 163
 164 Debian installation
 165 -------------------
 166
 167 Having been exposed to the wonders of NeuroDebian_ you are no longer
 168 satisfied with your previous choice of operating system?  We would
 169 recommend installing Debian_ to replace or complement (dual-boot) your
 170 existing OS.  Please visit `"Getting Debian"
 171 <http://www.debian.org/distrib/>`_ to obtain the images for your
 172 hardware architecture and then simply add |repos|.
 173
 174
 175 .. _chap_team:
 176
 177
 178 The team
 179 ========
 180
 181 Our main goal is to provide neuroscience FOSS_ for Debian_. Thus the
 182 whole project would not be possible without the work of over 3,000
 183 Debian_ developers and contributors who are as enthusiastically pursuing
 184 a similar goal.  To add our share -- Debian_ packages of FOSS_ for
 185 neuroscience research -- the `Experimental Psychology Debian packaging
 186 project <http://alioth.debian.org/projects/pkg-exppsy>`_ was created
 187 to formally join the forces of
 188
 189 * `Michael Hanke <http://mih.voxindeserto.de>`_
 190 * `Yaroslav Halchenko <http://www.onerussian.com>`_
 191
 192 A number of packages that are now available from the NeuroDebian repository
 193 were not packaged by our team, but similar Debian teams.  Therefore we want to
 194 express particular gratitude to the `Debian Med`_ and `Debian Science`_ teams
 195 for all their work.
 196
 197 .. _support:
 198
 199 Contacts
 200 ========
 201
 202 `Email us directly <team@neuro.debian.net>`_ with any "private"
 203 communication.  Otherwise please use our public mailing lists, which
 204 exist not only to provide user-support but also to establish
 205 communication channels within the NeuroDebian community
 206
 207 * neurodebian-users_: Discussions and support of NeuroDebian users
 208
 209 * neurodebian-upstream_: General discussions and knowledge sharing
 210   among developers of the neuroscience software.  We will also use it
 211   to update you with summaries of recent relevant developments in
 212   Debian project
 213
 214 * neurodebian-devel_: Technical mailing list for discussions on
 215   NeuroDebian development
 216
 217
 218 Acknowledgements
 219 ================
 220
 221 We are grateful to `Jim Haxby`_ for his continued support and :ref:`endless supply of
 222 Italian espresso <coffeeart>`.
 223
 224 .. _Jim Haxby: http://haxbylab.dartmouth.edu/ppl/jim.html
 225
 226 Publications
 227 ============
 228
 229 Hanke, M. & Halchenko, Y. O. (2010). :ref:`Report from the Debian booth at
 230 SfN2010 <chap_debian_booth_sfn2010>`. *Annual meeting of the Society for
 231 Neuroscience*, San Diego, USA.
 232
 233 Halchenko, Y. O., Hanke, M., Haxby, J. V., Pollmann, S. & Raizada, R. D.
 234 (2010). `Having trouble getting your Nature paper? Maybe you are not using the
 235 right tools? <_files/NeuroDebian_SfN2010.png>`_ *Poster to be presented at the
 236 annual meeting of the Society for Neuroscience*, San Diego, USA.
 237
 238 Hanke, M., Halchenko, Y. O. (2010). `Debian: The ultimate platform for
 239 neuroimaging research <_files/HankeHalchenko_NeuroDebianDebConf10.pdf>`_.
 240 *Talk given at* DebConf10_, New York City, USA. [video:
 241 `low resolution <http://meetings-archive.debian.net/pub/debian-meetings/2010/debconf10/low/1310_1310_Debian_The_ultimate_platform_for_neuroimaging_research.ogv>`_,
 242 `high resolution <http://meetings-archive.debian.net/pub/debian-meetings/2010/debconf10/high/1310_1310_Debian_The_ultimate_platform_for_neuroimaging_research.ogv>`_]
 243
 244 Hanke, M., Halchenko, Y. O., Haxby, J. V. & Pollmann, S. (2010). `Improving
 245 efficiency in cognitive neuroscience research with NeuroDebian
 246 <_files/NeuroDebian_CNS2010.pdf>`_. *Poster presented at the annual
 247 meeting of the Cognitive Neuroscience Society*, Montréal, Canada.
 248
 249 Halchenko, Y. O., Hanke, M. (2009). `An ecosystem of neuroimaging,
 250 statistical learning, and open-source software to make research more
 251 efficient, more open, and more fun
 252 <_files/HalchenkoHanke_FossEcosystemDC09.pdf>`_. *Talk given at*
 253 `Dartmouth College`_, New Hampshire, USA.
 254
 255 .. _DebConf10: http://debconf10.debconf.org/
 256 .. _Dartmouth College: http://www.dartmouth.edu/
 257
 258
 259 .. toctree::
 260    :hidden:
 261
 262    faq
 263    pkgs
 264    spread
 265    vm
 266    coffeeart
 267    photoalbum
 268    projects
 269    testimonials
 270
 271 .. probably should be purged altogether
 272 .. toctree::
 273    :hidden:
 274
 275    booth_sfn2010
 276    datasets
 277    livecd
 278    quotes-nihr01
 279    quotes-nitrc
 280    sources_lists
 281    vm_welcome
 282
 283 .. include:: link_names.txt
 284 .. include:: substitutions.txt