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