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