sphinx/index.rst

   1 ***********************************************
   2  Welcome to the Debian Neuroscience Repository
   3 ***********************************************
   4
   5 This repository provides mostly neuroscience-related packages to be used on
   6 Debian systems (or Debian-derivatives like Ubuntu). It contains both unofficial
   7 or prospective packages which are not (yet) available from the main Debian
   8 archive, as well backported or simply rebuilt packages also available
   9 elsewhere. Please see the :ref:`faq` for more information about the goals of
  10 this project.
  11
  12 This service is provided "as is". There is no guarantee that a package
  13 works as expected, so use them at your own risk. They might kill your
  14 system (although that is rather unlikely). You've been warned!
  15
  16 The repository contains both neuroscience-related packages, as well as general
  17 purpose software which is necessary to resolve dependencies, or such that is
  18 simply useful in the neuroscience context. All featured neuroscience software
  19 packages are available from the :ref:`full package list <full_pkg_list>`.
  20
  21 News
  22 ====
  23
  24 .. raw:: html
  25
  26  <script src="http://widgets.twimg.com/j/2/widget.js"></script>
  27  <script>
  28  new TWTR.Widget({
  29    version: 2,
  30    type: 'profile',
  31    rpp: 4,
  32    interval: 6000,
  33    width: 'auto',
  34    height: 150,
  35    theme: {
  36      shell: {
  37        background: '#898989',
  38        color: '#ffffff'
  39      },
  40      tweets: {
  41        background: '#ffffff',
  42        color: '#000000',
  43        links: '#82032f'
  44      }
  45    },
  46    features: {
  47      scrollbar: true,
  48      loop: false,
  49      live: false,
  50      hashtags: true,
  51      timestamp: true,
  52      avatars: false,
  53      behavior: 'all'
  54    }
  55  }).render().setUser('NeuroDebian').start();
  56  </script>
  57
  58 .. _repository_howto:
  59
  60 How to use this repository
  61 ==========================
  62
  63 The easiest way to use this repository is to download an APT-configuration file
  64 (`sources.list`). Simply choose your target distribution/release and download
  65 the configuration for a mirror close to you (depending on your browser, you
  66 might have to right-click and choose 'save as'). Once downloaded, put the file
  67 in the `/etc/apt/sources.list.d/` directory on your system. Moving files in
  68 this directory will require superuser privileges, therefore you should probably
  69 download the file into a temporary directory and subsequently move it into
  70 `/etc/apt/sources.list.d/`. APT-configurations are available for the following
  71 releases and repository mirrors:
  72
  73 .. include:: sources_lists
  74
  75 .. note::
  76   Thanks to the `Department of Experimental Psychology at the University of
  77   Magdeburg`_, and the `Department of Psychological and Brain Sciences at Dartmouth
  78   College`_ for hosting a mirror.
  79
  80   If your are interested in mirroring the repository, please see the :ref:`faq`.
  81
  82 .. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de
  83 .. _Department of Psychological and Brain Sciences at Dartmouth College: http://www.dartmouth.edu/~psych
  84
  85 Once this is done, you have to update the package index. Use your favorite
  86 package manager, e.g. synaptic, adept, or whatever you like. In the terminal
  87 you can use :command:`aptitude` to achieve the same::
  88
  89   sudo aptitude update
  90
  91 Now, you can proceed to install packages, e.g.::
  92
  93   sudo aptitude install lipsia
  94
  95 .. note::
  96   Not every package is available for all distributions/releases. For information
  97   about which package version is available for which release and architecture,
  98   please have a look at the corresponding package pages.
  99
 100
 101 Package authentication
 102 ----------------------
 103
 104 When you start using this repository, you probably get warning messages
 105 like this::
 106
 107   The following signatures couldn't be verified because
 108   the public key is not available.`
 109
 110 Or you will be asked questions like this over and over::
 111
 112   WARNING: The following packages cannot be authenticated!
 113   ...
 114   Install these packages without verification [y/N]?
 115
 116 This is because your APT installation initially does not know the GPG
 117 key that is used to sign the release files of this repository. Making
 118 APT happy again is easy:
 119
 120 1. Get the key. Either download the `repository key from here
 121    <_static/neuro.debian.net.asc>`_
 122    or fetch it from http://wwwkeys.pgp.net (2649A5A9).
 123
 124 2. Now feed the key into APT by invoking::
 125
 126      apt-key add #file#
 127
 128    Where `#file#` has to be replaced with the location of the key file you just
 129    downloaded. You need to have superuser-privileges to do this (either do it
 130    as root or use sudo).
 131
 132
 133 Virtual Machine
 134 ===============
 135
 136 If your are not running a Debian on a particular machine a :ref:`chap_vm` is
 137 provided as a convenient testing and evaluation environment.