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 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. They might kill your
  16 system (although that is rather unlikely). You've been warned!
  17
  18 The repository contains both neuroscience-related packages, as well as general
  19 purpose software which is necessary to resolve dependencies, or such that is
  20 simply useful in the neuroscience context. All featured neuroscience software
  21 packages are available from the :ref:`full package list <full_pkg_list>`.
  22
  23 .. raw:: html
  24
  25  <p>
  26  <a href="pkgs.html"><img border="0" src="_static/package.png" title="List of available packages" /></a>
  27  <a href="vm.html"><img border="0" src="_static/machine.png" title="Get NeuroDebian for your non-Debian computer" /></a>
  28  <a href="debian/pool"><img border="0" src="_static/pool.png" title="Go to the package pool (deep and cold, only for experts)" /></a>
  29  </p>
  30
  31
  32 News
  33 ====
  34
  35 .. raw:: html
  36
  37  <script src="http://widgets.twimg.com/j/2/widget.js"></script>
  38  <script>
  39  new TWTR.Widget({
  40    version: 2,
  41    type: 'profile',
  42    rpp: 10,
  43    interval: 6000,
  44    width: 'auto',
  45    height: 150,
  46    theme: {
  47      shell: {
  48        background: '#898989',
  49        color: '#ffffff'
  50      },
  51      tweets: {
  52        background: '#ffffff',
  53        color: '#000000',
  54        links: '#82032f'
  55      }
  56    },
  57    features: {
  58      scrollbar: true,
  59      loop: false,
  60      live: false,
  61      hashtags: true,
  62      timestamp: true,
  63      avatars: false,
  64      behavior: 'all'
  65    }
  66  }).render().setUser('NeuroDebian').start();
  67  </script>
  68
  69 Follow us on twitter_ to subscribe to the NeuroDebian news.
  70
  71 .. _twitter: http://twitter.com/NeuroDebian
  72
  73 .. _repository_howto:
  74
  75
  76
  77 How to use this repository
  78 ==========================
  79
  80 The easiest way to use this repository is to download an APT-configuration file
  81 (`sources.list`). Simply choose your target distribution/release and download
  82 the configuration for a mirror close to you (depending on your browser, you
  83 might have to right-click and choose 'save as'). Once downloaded, put the file
  84 in the `/etc/apt/sources.list.d/` directory on your system. Moving files in
  85 this directory will require superuser privileges, therefore you should probably
  86 download the file into a temporary directory and subsequently move it into
  87 `/etc/apt/sources.list.d/`. APT-configurations are available for the following
  88 releases and repository mirrors:
  89
  90 .. include:: sources_lists
  91
  92 .. note::
  93   Thanks to the `Department of Experimental Psychology at the University of
  94   Magdeburg`_, and the `Department of Psychological and Brain Sciences at Dartmouth
  95   College`_ 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
 102 Once this is done, you have to update the package index. Use your favorite
 103 package manager, e.g. synaptic, adept, or whatever you like. In the terminal
 104 you can use :command:`aptitude` to achieve the same::
 105
 106   sudo aptitude update
 107
 108 Now, you can proceed to install packages, e.g.::
 109
 110   sudo aptitude install lipsia
 111
 112 .. note::
 113   Not every package is available for all distributions/releases. For information
 114   about which package version is available for which release and architecture,
 115   please have a look at the corresponding package pages.
 116
 117
 118 Package authentication
 119 ----------------------
 120
 121 When you start using this repository, you probably get warning messages
 122 like this::
 123
 124   The following signatures couldn't be verified because
 125   the public key is not available.`
 126
 127 Or you will be asked questions like this over and over::
 128
 129   WARNING: The following packages cannot be authenticated!
 130   ...
 131   Install these packages without verification [y/N]?
 132
 133 This is because your APT installation initially does not know the GPG
 134 key that is used to sign the release files of this repository. Making
 135 APT happy again is easy:
 136
 137 1. Get the key. Either download the `repository key from here
 138    <_static/neuro.debian.net.asc>`_
 139    or fetch it from http://wwwkeys.pgp.net (2649A5A9).
 140
 141 2. Now feed the key into APT by invoking::
 142
 143      apt-key add #file#
 144
 145    Where `#file#` has to be replaced with the location of the key file you just
 146    downloaded. You need to have superuser-privileges to do this (either do it
 147    as root or use sudo).
 148
 149
 150 .. _chap_installation:
 151
 152 Installation
 153 ============
 154
 155 Virtual Machine
 156 ---------------
 157
 158 If your are not running Debian_ on a particular machine a :ref:`chap_vm` is
 159 provided as a convenient testing and evaluation environment.  After a
 160 few simple steps to setup the virtual machine, you will be able to use
 161 NeuroDebian_ as an integral part of your existing working
 162 environment without any sacrifice.
 163
 164
 165 Debian
 166 ------
 167
 168 Having been exposed to the wonders of NeuroDebian_ you are no longer
 169 satisfied with your previous choice of operating system?  We would
 170 recommend installing Debian_ to replace or complement (dual-boot) your
 171 existing OS.  Please visit `"Getting Debian"
 172 <http://www.debian.org/distrib/>`_ to obtain the images for your
 173 hardware architecture and then simply add |repos|.
 174
 175
 176 .. _chap_team:
 177
 178
 179 The Team
 180 ========
 181
 182 Our main goal is to provide neuroscience FOSS for Debian_. Thus the
 183 whole project would not be possible without the work of over 3,000
 184 Debian_ developers and contributors who are as enthusiastically pursuing
 185 a similar goal.  To add our share -- Debian_ packages of FOSS for
 186 neuroscience research -- the `Experimental Psychology Debian packaging
 187 project <http://alioth.debian.org/projects/pkg-exppsy>`_ was created
 188 to formally join the forces of
 189
 190 * `Michael Hanke <http://mih.voxindeserto.de>`_
 191 * `Yaroslav Halchenko <http://www.onerussian.com>`_
 192
 193 A number of packages that are now provided within the NeuroDebian repository
 194 were not packaged by our team, but similar Debian teams.  Therefore we want to
 195 express particular gratitude to `Debian Med`_ and `Debian Science`_ teams for
 196 all their work.
 197
 198
 199 Contact
 200 =======
 201
 202 `Email us <team@neuro.debian.net>`_ if you have any suggestions or
 203 simply |spread| if you liked it.
 204
 205 .. toctree::
 206    :hidden:
 207
 208    faq
 209    pkgs
 210    spread
 211    vm
 212    links_names
 213    substitutions
 214
 215 .. probably should be purged altogether
 216 .. toctree::
 217    :hidden:
 218
 219    livecd
 220    gpg
 221    setup
 222
 223 .. include:: links_names.rst
 224 .. include:: substitutions.rst