sphinx/index.rst

   1 .. _WELCOme:
   2
   3 ***********************************************
   4  Welcome to the Debian Neuroscience Repository
   5 ***********************************************
   6
   7 This repository provides mostly neuroscience-related packages to be used on
   8 Debian_ systems (or Debian-derivatives like Ubuntu_). It contains both unofficial
   9 or prospective packages which are not (yet) available from the main Debian_
  10 archive, as well as backported or simply rebuilt packages also available
  11 elsewhere. Please see the :ref:`faq` for more information about the goals of
  12 this project.
  13
  14 This service is provided "as is". There is no guarantee that a package
  15 works as expected, so use them at your own risk. If you encounter problems,
  16 please `report <#contacts>`_ them.
  17
  18 Please |spread|, if you like it.
  19
  20 .. raw:: html
  21
  22  <p>
  23  <a href="pkgs.html"><img border="0" src="_static/package.png" title="Software package list" /></a>
  24  <a href="datasets.html"><img border="0" src="_static/datasets.png" title="Dataset package list" /></a>
  25  <a href="vm.html"><img border="0" src="_static/machine.png" title="Get NeuroDebian for your non-Debian computer" /></a>
  26  <a href="debian/pool"><img border="0" src="_static/pool.png" title="Go to the package pool (deep and cold, only for experts)" /></a>
  27  </p>
  28
  29 .. _Ubuntu: http://www.ubuntu.com
  30
  31 News
  32 ====
  33
  34 .. raw:: html
  35
  36  <script src="http://widgets.twimg.com/j/2/widget.js"></script>
  37  <script>
  38  new TWTR.Widget({
  39    version: 2,
  40    type: 'profile',
  41    rpp: 10,
  42    interval: 6000,
  43    width: 'auto',
  44    height: 150,
  45    theme: {
  46      shell: {
  47        background: '#898989',
  48        color: '#ffffff'
  49      },
  50      tweets: {
  51        background: '#ffffff',
  52        color: '#000000',
  53        links: '#82032f'
  54      }
  55    },
  56    features: {
  57      scrollbar: true,
  58      loop: false,
  59      live: false,
  60      hashtags: true,
  61      timestamp: true,
  62      avatars: false,
  63      behavior: 'all'
  64    }
  65  }).render().setUser('NeuroDebian').start();
  66  </script>
  67
  68 Follow us on twitter_ to subscribe to the NeuroDebian news.
  69
  70 .. _twitter: http://twitter.com/NeuroDebian
  71
  72 .. _repository_howto:
  73
  74
  75
  76 How to use this repository
  77 ==========================
  78
  79 The easiest way to use this repository is to download an APT-configuration file
  80 (`sources.list`). Simply choose your target distribution/release and download
  81 the configuration for a mirror close to you (depending on your browser, you
  82 might have to right-click and choose 'save as'). Once downloaded, put the file
  83 in the `/etc/apt/sources.list.d/` directory on your system. Moving files in
  84 this directory will require superuser privileges, therefore you should probably
  85 download the file into a temporary directory and subsequently move it into
  86 `/etc/apt/sources.list.d/`. APT-configurations are available for the following
  87 releases and repository mirrors:
  88
  89 .. include:: sources_lists
  90
  91 .. note::
  92   Thanks to the following institutions and individuals for hosting a mirror:
  93
  94   * `Department of Psychological and Brain Sciences at Dartmouth College`_
  95     *[us-nh]* (primary mirror)
  96   * `Department of Experimental Psychology at the University of Magdeburg`_
  97     *[de]*
  98   * `Neurobot at Aristotle University of Thessaloniki, Greece`_ *[gr]*
  99   * `Paul Ivanov`_ *[us-ca]*
 100   * `Medical-image Analysis and Statistical Interpretation lab at Vanderbilt`_
 101     *[us-tn]*
 102
 103   If your are interested in mirroring the repository, please see the :ref:`faq`.
 104
 105 .. _Department of Psychological and Brain Sciences at Dartmouth College: http://www.dartmouth.edu/~psych
 106 .. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de
 107 .. _Neurobot at Aristotle University of Thessaloniki, Greece: http://neurobot.bio.auth.gr
 108 .. _Paul Ivanov: http://www.pirsquared.org
 109 .. _Medical-image Analysis and Statistical Interpretation lab at Vanderbilt: https://masi.vuse.vanderbilt.edu
 110
 111 Once this is done, you have to update the package index. Use your favorite
 112 package manager, e.g. synaptic, adept, or whatever you like. In the terminal
 113 you can use :command:`aptitude` to achieve the same::
 114
 115   sudo aptitude update
 116
 117 Now, you can proceed to install packages, e.g.::
 118
 119   sudo aptitude install lipsia
 120
 121 .. note::
 122   Not every package is available for all distributions/releases. For information
 123   about which package version is available for which release and architecture,
 124   please have a look at the corresponding package pages.
 125
 126
 127 Package authentication
 128 ----------------------
 129
 130 When you start using this repository, you probably get warning messages
 131 like this::
 132
 133   The following signatures couldn't be verified because
 134   the public key is not available.
 135
 136 Or you will be asked questions like this over and over::
 137
 138   WARNING: The following packages cannot be authenticated!
 139   ...
 140   Install these packages without verification [y/N]?
 141
 142 This is because your APT installation initially does not know the GPG
 143 key that is used to sign the release files of this repository. It is easy to
 144 make APT happy again:
 145
 146 1. Get the key. Either download the `repository key from here
 147    <_static/neuro.debian.net.asc>`_
 148    or fetch it from http://wwwkeys.pgp.net (2649A5A9).
 149
 150 2. Now feed the key into APT by invoking::
 151
 152      apt-key add #file#
 153
 154    Where `#file#` has to be replaced with the location of the key file you just
 155    downloaded. You need to have superuser-privileges to do this (either do it
 156    as root or use sudo).
 157
 158
 159 .. _chap_installation:
 160
 161 Installation
 162 ============
 163
 164 Virtual Machine
 165 ---------------
 166
 167 If you are not running Debian_ on a particular machine a :ref:`chap_vm` is
 168 provided as a convenient testing and evaluation environment.  After a few
 169 simple steps to setup the virtual machine, you will be able to use NeuroDebian_
 170 as an integral part of your existing working environment without any sacrifice.
 171 The virtual machine is also a suitable environment to temporarily deploy
 172 neuroscience software on machines running other operating systems, e.g. for the
 173 purpose of teaching a neuroimaging data analysis course in a multipurpose
 174 computer lab.
 175
 176
 177 Debian
 178 ------
 179
 180 Having been exposed to the wonders of NeuroDebian_ you are no longer
 181 satisfied with your previous choice of operating system?  We would
 182 recommend installing Debian_ to replace or complement (dual-boot) your
 183 existing OS.  Please visit `"Getting Debian"
 184 <http://www.debian.org/distrib/>`_ to obtain the images for your
 185 hardware architecture and then simply add |repos|.
 186
 187
 188 .. _chap_team:
 189
 190
 191 The Team
 192 ========
 193
 194 Our main goal is to provide neuroscience FOSS_ for Debian_. Thus the
 195 whole project would not be possible without the work of over 3,000
 196 Debian_ developers and contributors who are as enthusiastically pursuing
 197 a similar goal.  To add our share -- Debian_ packages of FOSS_ for
 198 neuroscience research -- the `Experimental Psychology Debian packaging
 199 project <http://alioth.debian.org/projects/pkg-exppsy>`_ was created
 200 to formally join the forces of
 201
 202 * `Michael Hanke <http://mih.voxindeserto.de>`_
 203 * `Yaroslav Halchenko <http://www.onerussian.com>`_
 204
 205 A number of packages that are now available from the NeuroDebian repository
 206 were not packaged by our team, but similar Debian teams.  Therefore we want to
 207 express particular gratitude to the `Debian Med`_ and `Debian Science`_ teams
 208 for all their work.
 209
 210 .. _FOSS: http://en.wikipedia.org/wiki/Free_and_open_source_software
 211
 212
 213 Contacts
 214 ========
 215
 216 `Email us directly <team@neuro.debian.net>`_ with any "private"
 217 communication.  Otherwise please use our public mailing lists, which
 218 exist not only to provide user-support but also to establish
 219 communication channels within the NeuroDebian community
 220
 221 * neurodebian-users_: Discussions and support of NeuroDebian users
 222
 223 * neurodebian-upstream_: General discussions and knowledge sharing
 224   among developers of the neuroscience software.  We will also use it
 225   to update you with summaries of recent relevant developments in
 226   Debian project
 227
 228 * neurodebian-devel_: Technical mailing list for discussions on
 229   NeuroDebian development
 230
 231 .. _neurodebian-users: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-users
 232 .. _neurodebian-devel: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-devel
 233 .. _neurodebian-upstream: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-upstream
 234
 235
 236 Acknowledgements
 237 ================
 238
 239 We are grateful to Jim Haxby for his continued support and :ref:`endless supply of
 240 Italian espresso <coffeeart>`.
 241
 242
 243 .. toctree::
 244    :hidden:
 245
 246    faq
 247    pkgs
 248    spread
 249    vm
 250    coffeeart
 251
 252 .. probably should be purged altogether
 253 .. toctree::
 254    :hidden:
 255
 256    livecd
 257    gpg
 258    setup
 259    links_names
 260    substitutions
 261
 262 .. include:: links_names.rst
 263 .. include:: substitutions.rst