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