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 <#contacts>`_ 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="Software package list" /></a>
  24  <a href="datasets.html"><img border="0" src="_static/datasets.png" title="Dataset package list" /></a>
  25  <a href="vm.html"><img border="0" src="_static/machine.png" title="Get NeuroDebian for your non-Debian computer" /></a>
  26  <a href="debian/pool"><img border="0" src="_static/pool.png" title="Go to the package pool (deep and cold, only for experts)" /></a>
  27  </p>
  28
  29 .. _Ubuntu: http://www.ubuntu.com
  30
  31 News
  32 ====
  33
  34 .. raw:: html
  35
  36  <script src="http://widgets.twimg.com/j/2/widget.js"></script>
  37  <script>
  38  new TWTR.Widget({
  39    version: 2,
  40    type: 'profile',
  41    rpp: 15,
  42    interval: 6000,
  43    width: 'auto',
  44    height: 150,
  45    theme: {
  46      shell: {
  47        background: '#898989',
  48        color: '#ffffff'
  49      },
  50      tweets: {
  51        background: '#ffffff',
  52        color: '#000000',
  53        links: '#82032f'
  54      }
  55    },
  56    features: {
  57      scrollbar: true,
  58      loop: false,
  59      live: false,
  60      hashtags: true,
  61      timestamp: true,
  62      avatars: false,
  63      behavior: 'all'
  64    }
  65  }).render().setUser('NeuroDebian').start();
  66  </script>
  67
  68 Follow us on twitter_ to subscribe to the NeuroDebian news.
  69
  70 .. _twitter: http://twitter.com/NeuroDebian
  71
  72 .. _repository_howto:
  73
  74
  75
  76 How to use this repository
  77 ==========================
  78
  79 The easiest way to use this repository is to download an APT-configuration file
  80 (`sources.list`). Simply choose your target distribution/release and download
  81 the configuration for a mirror close to you (depending on your browser, you
  82 might have to right-click and choose 'save as'). Once downloaded, put the file
  83 in the `/etc/apt/sources.list.d/` directory on your system. Moving files in
  84 this directory will require superuser privileges, therefore you should probably
  85 download the file into a temporary directory and subsequently move it into
  86 `/etc/apt/sources.list.d/`. APT-configurations are available for the following
  87 releases and repository mirrors:
  88
  89 .. include:: sources_lists
  90
  91 .. note::
  92   Thanks to the following institutions and individuals for hosting a mirror:
  93
  94   * `Department of Psychological and Brain Sciences at Dartmouth College`_
  95     *[us-nh]* (primary mirror)
  96   * `Department of Experimental Psychology at the University of Magdeburg`_
  97     *[de]*
  98   * `Neurobot at Aristotle University of Thessaloniki, Greece`_ *[gr]*
  99   * `Paul Ivanov`_ *[us-ca]*
 100   * `Medical-image Analysis and Statistical Interpretation lab at Vanderbilt`_
 101     *[us-tn]*
 102
 103   If your are interested in mirroring the repository, please see the :ref:`faq`.
 104
 105 .. _Department of Psychological and Brain Sciences at Dartmouth College: http://www.dartmouth.edu/~psych
 106 .. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de
 107 .. _Neurobot at Aristotle University of Thessaloniki, Greece: http://neurobot.bio.auth.gr
 108 .. _Paul Ivanov: http://www.pirsquared.org
 109 .. _Medical-image Analysis and Statistical Interpretation lab at Vanderbilt: https://masi.vuse.vanderbilt.edu
 110
 111 Once this is done, you have to update the package index. Use your favorite
 112 package manager, e.g. synaptic, adept, or whatever you like. In the terminal
 113 you can use :command:`aptitude` to achieve the same::
 114
 115   sudo aptitude update
 116
 117 Now, you can proceed to install packages, e.g.::
 118
 119   sudo aptitude install lipsia
 120
 121 .. note::
 122   Not every package is available for all distributions/releases. For information
 123   about which package version is available for which release and architecture,
 124   please have a look at the corresponding package pages.
 125
 126 After this initial setup you probably also want to configure your package
 127 manager to recognize the NeuroDebian archive key. With this key the package
 128 manager can verify that packages haven't been modified and are identical with
 129 the ones in the main NeuroDebian archive, regardless of which mirror you
 130 downloaded them from. The NeuroDebian key id is **2649A5A9**. If you need further
 131 help setting up package authentication, please take a look at
 132 :ref:`corresponding FAQ <sec_pkg_authentication>`.
 133
 134
 135 .. _chap_installation:
 136
 137 Ways to use NeuroDebian
 138 =======================
 139
 140 Virtual machine
 141 ---------------
 142
 143 If you are not running Debian_ on a particular machine a :ref:`chap_vm` is
 144 provided as a convenient testing and evaluation environment.  After a few
 145 simple steps to setup the virtual machine, you will be able to use NeuroDebian_
 146 as an integral part of your existing working environment without any sacrifice.
 147 The virtual machine is also a suitable environment to temporarily deploy
 148 neuroscience software on machines running other operating systems, e.g. for the
 149 purpose of teaching a neuroimaging data analysis course in a multipurpose
 150 computer lab.
 151
 152
 153 Debian installation
 154 -------------------
 155
 156 Having been exposed to the wonders of NeuroDebian_ you are no longer
 157 satisfied with your previous choice of operating system?  We would
 158 recommend installing Debian_ to replace or complement (dual-boot) your
 159 existing OS.  Please visit `"Getting Debian"
 160 <http://www.debian.org/distrib/>`_ to obtain the images for your
 161 hardware architecture and then simply add |repos|.
 162
 163
 164 .. _chap_team:
 165
 166
 167 The team
 168 ========
 169
 170 Our main goal is to provide neuroscience FOSS_ for Debian_. Thus the
 171 whole project would not be possible without the work of over 3,000
 172 Debian_ developers and contributors who are as enthusiastically pursuing
 173 a similar goal.  To add our share -- Debian_ packages of FOSS_ for
 174 neuroscience research -- the `Experimental Psychology Debian packaging
 175 project <http://alioth.debian.org/projects/pkg-exppsy>`_ was created
 176 to formally join the forces of
 177
 178 * `Michael Hanke <http://mih.voxindeserto.de>`_
 179 * `Yaroslav Halchenko <http://www.onerussian.com>`_
 180
 181 A number of packages that are now available from the NeuroDebian repository
 182 were not packaged by our team, but similar Debian teams.  Therefore we want to
 183 express particular gratitude to the `Debian Med`_ and `Debian Science`_ teams
 184 for all their work.
 185
 186 .. _FOSS: http://en.wikipedia.org/wiki/Free_and_open_source_software
 187
 188
 189 Contacts
 190 ========
 191
 192 `Email us directly <team@neuro.debian.net>`_ with any "private"
 193 communication.  Otherwise please use our public mailing lists, which
 194 exist not only to provide user-support but also to establish
 195 communication channels within the NeuroDebian community
 196
 197 * neurodebian-users_: Discussions and support of NeuroDebian users
 198
 199 * neurodebian-upstream_: General discussions and knowledge sharing
 200   among developers of the neuroscience software.  We will also use it
 201   to update you with summaries of recent relevant developments in
 202   Debian project
 203
 204 * neurodebian-devel_: Technical mailing list for discussions on
 205   NeuroDebian development
 206
 207 .. _neurodebian-users: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-users
 208 .. _neurodebian-devel: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-devel
 209 .. _neurodebian-upstream: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-upstream
 210
 211
 212 Acknowledgements
 213 ================
 214
 215 We are grateful to Jim Haxby for his continued support and :ref:`endless supply of
 216 Italian espresso <coffeeart>`.
 217
 218
 219 .. toctree::
 220    :hidden:
 221
 222    faq
 223    pkgs
 224    spread
 225    vm
 226    coffeeart
 227
 228 .. probably should be purged altogether
 229 .. toctree::
 230    :hidden:
 231
 232    livecd
 233    gpg
 234    setup
 235    links_names
 236    substitutions
 237
 238 .. include:: links_names.rst
 239 .. include:: substitutions.rst