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