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