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