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