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 <#contact>`_ 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 `Department of Psychological and Brain Sciences at
  92   Dartmouth College`_ `[us-nh]` (primary mirror), the `Department of
  93   Experimental Psychology at the University of Magdeburg`_ `[de]`, and
  94   the `Medical-image Analysis and Statistical Interpretation lab at
  95   Vanderbilt`_ `[us-tn]` for hosting a mirror.
  96
  97   If your are interested in mirroring the repository, please see the :ref:`faq`.
  98
  99 .. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de
 100 .. _Department of Psychological and Brain Sciences at Dartmouth College: http://www.dartmouth.edu/~psych
 101 .. _Medical-image Analysis and Statistical Interpretation lab at Vanderbilt: https://masi.vuse.vanderbilt.edu
 102
 103 Once this is done, you have to update the package index. Use your favorite
 104 package manager, e.g. synaptic, adept, or whatever you like. In the terminal
 105 you can use :command:`aptitude` to achieve the same::
 106
 107   sudo aptitude update
 108
 109 Now, you can proceed to install packages, e.g.::
 110
 111   sudo aptitude install lipsia
 112
 113 .. note::
 114   Not every package is available for all distributions/releases. For information
 115   about which package version is available for which release and architecture,
 116   please have a look at the corresponding package pages.
 117
 118
 119 Package authentication
 120 ----------------------
 121
 122 When you start using this repository, you probably get warning messages
 123 like this::
 124
 125   The following signatures couldn't be verified because
 126   the public key is not available.
 127
 128 Or you will be asked questions like this over and over::
 129
 130   WARNING: The following packages cannot be authenticated!
 131   ...
 132   Install these packages without verification [y/N]?
 133
 134 This is because your APT installation initially does not know the GPG
 135 key that is used to sign the release files of this repository. It is easy to
 136 make APT happy again:
 137
 138 1. Get the key. Either download the `repository key from here
 139    <_static/neuro.debian.net.asc>`_
 140    or fetch it from http://wwwkeys.pgp.net (2649A5A9).
 141
 142 2. Now feed the key into APT by invoking::
 143
 144      apt-key add #file#
 145
 146    Where `#file#` has to be replaced with the location of the key file you just
 147    downloaded. You need to have superuser-privileges to do this (either do it
 148    as root or use sudo).
 149
 150
 151 .. _chap_installation:
 152
 153 Installation
 154 ============
 155
 156 Virtual Machine
 157 ---------------
 158
 159 If you are not running Debian_ on a particular machine a :ref:`chap_vm` is
 160 provided as a convenient testing and evaluation environment.  After a few
 161 simple steps to setup the virtual machine, you will be able to use NeuroDebian_
 162 as an integral part of your existing working environment without any sacrifice.
 163 The virtual machine is also a suitable environment to temporarily deploy
 164 neuroscience software on machines running other operating systems, e.g. for the
 165 purpose of teaching a neuroimaging data analysis course in a multipurpose
 166 computer lab.
 167
 168
 169 Debian
 170 ------
 171
 172 Having been exposed to the wonders of NeuroDebian_ you are no longer
 173 satisfied with your previous choice of operating system?  We would
 174 recommend installing Debian_ to replace or complement (dual-boot) your
 175 existing OS.  Please visit `"Getting Debian"
 176 <http://www.debian.org/distrib/>`_ to obtain the images for your
 177 hardware architecture and then simply add |repos|.
 178
 179
 180 .. _chap_team:
 181
 182
 183 The Team
 184 ========
 185
 186 Our main goal is to provide neuroscience FOSS_ for Debian_. Thus the
 187 whole project would not be possible without the work of over 3,000
 188 Debian_ developers and contributors who are as enthusiastically pursuing
 189 a similar goal.  To add our share -- Debian_ packages of FOSS_ for
 190 neuroscience research -- the `Experimental Psychology Debian packaging
 191 project <http://alioth.debian.org/projects/pkg-exppsy>`_ was created
 192 to formally join the forces of
 193
 194 * `Michael Hanke <http://mih.voxindeserto.de>`_
 195 * `Yaroslav Halchenko <http://www.onerussian.com>`_
 196
 197 A number of packages that are now available from the NeuroDebian repository
 198 were not packaged by our team, but similar Debian teams.  Therefore we want to
 199 express particular gratitude to the `Debian Med`_ and `Debian Science`_ teams
 200 for all their work.
 201
 202 .. _FOSS: http://en.wikipedia.org/wiki/Free_and_open_source_software
 203
 204
 205 Contact
 206 =======
 207
 208 `Email us <team@neuro.debian.net>`_ if you have any suggestions or want to
 209 report a problem.
 210
 211 .. toctree::
 212    :hidden:
 213
 214    faq
 215    pkgs
 216    spread
 217    vm
 218
 219 .. probably should be purged altogether
 220 .. toctree::
 221    :hidden:
 222
 223    livecd
 224    gpg
 225    setup
 226    links_names
 227    substitutions
 228
 229 .. include:: links_names.rst
 230 .. include:: substitutions.rst