+.. _WELCOme:
+
***********************************************
Welcome to the Debian Neuroscience Repository
***********************************************
-This repository provides mostly neuroscience-related packages to be
-used on Debian systems (or Debian-derivatives like Ubuntu). It
-contains both unofficial or prospective packages which are not
-available from the main Debian archive, as well backported or simply
-rebuilt packages also available elsewhere.
+.. quotes::
+ :random: 1
+
+This repository provides mostly neuroscience-related packages to be used on
+Debian_ systems (or Debian-derivatives like Ubuntu_). It contains both unofficial
+or prospective packages which are not (yet) available from the main Debian_
+archive, as well as backported or simply rebuilt packages also available
+elsewhere. Please see the :ref:`faq` for more information about the goals of
+this project.
This service is provided "as is". There is no guarantee that a package
-works as expected, so use them at your own risk. They might kill your
-system (although that is rather unlikely). You've been warned!
+works as expected, so use them at your own risk. If you encounter problems,
+please `report <#contacts>`_ them.
+
+Please |spread|, if you like it.
-The repository contains both neuroscience-related packages, as well as general
-purpose software which is necessary to resolve dependencies, or such that is
-simply useful in the neuroscience context. The featured neuroscience software
-can be browsed via the repository :ref:`genindex` or through the
-:ref:`maintainer view <bymaintainer>`.
+.. raw:: html
-All other packages are available from the :ref:`full package list
-<full_pkg_list>`.
+ <p>
+ <a href="pkgs.html"><img border="0" src="_static/package.png" title="Software package list" /></a>
+ <a href="datasets.html"><img border="0" src="_static/datasets.png" title="Dataset package list" /></a>
+ <a href="vm.html"><img border="0" src="_static/machine.png" title="Get NeuroDebian for your non-Debian computer" /></a>
+ <a href="debian/pool"><img border="0" src="_static/pool.png" title="Go to the package pool (deep and cold, only for experts)" /></a>
+ </p>
+.. _Ubuntu: http://www.ubuntu.com
News
====
-Due to scheduled maintenance work on the electrical grid the repository hosted
-at `apsy.gse.uni.magdeburg.de/debian` will be down on May 16 (and possibly
-May 17).
-
+.. raw:: html
+
+ <script src="http://widgets.twimg.com/j/2/widget.js"></script>
+ <script>
+ new TWTR.Widget({
+ version: 2,
+ type: 'profile',
+ rpp: 15,
+ interval: 6000,
+ width: 'auto',
+ height: 150,
+ theme: {
+ shell: {
+ background: '#898989',
+ color: '#ffffff'
+ },
+ tweets: {
+ background: '#ffffff',
+ color: '#000000',
+ links: '#82032f'
+ }
+ },
+ features: {
+ scrollbar: true,
+ loop: false,
+ live: false,
+ hashtags: true,
+ timestamp: true,
+ avatars: false,
+ behavior: 'all'
+ }
+ }).render().setUser('NeuroDebian').start();
+ </script>
+
+Follow us on twitter_ to subscribe to the NeuroDebian news.
+
+.. _twitter: http://twitter.com/NeuroDebian
.. _repository_howto:
+
+
How to use this repository
==========================
The easiest way to use this repository is to download an APT-configuration file
-(`sources.list`). Simply click on the name of your target distribution/release
-and save the downloaded file in the `/etc/apt/sources.list.d/` directory on
-your system (depending on the browser, you might have to right-click and choose
-'save as'). Saving files in this directory will require superuser privileges,
-therefore you should probably download the file into a temporary directory and
-subsequently move it into `/etc/apt/sources.list.d/`. APT-configurations are
-available for the following releases:
+(`sources.list`). Simply choose your target distribution/release and download
+the configuration for a mirror close to you (depending on your browser, you
+might have to right-click and choose 'save as'). Once downloaded, put the file
+in the `/etc/apt/sources.list.d/` directory on your system. Moving files in
+this directory will require superuser privileges, therefore you should probably
+download the file into a temporary directory and subsequently move it into
+`/etc/apt/sources.list.d/`. APT-configurations are available for the following
+releases and repository mirrors:
.. include:: sources_lists
+.. note::
+ Thanks to the following institutions and individuals for hosting a mirror:
+
+ * `Department of Psychological and Brain Sciences at Dartmouth College`_
+ *[us-nh]* (primary mirror)
+ * `Department of Experimental Psychology at the University of Magdeburg`_
+ *[de]*
+ * `Neurobot at Aristotle University of Thessaloniki, Greece`_ *[gr]*
+ * `Paul Ivanov`_ *[us-ca]*
+ * `Medical-image Analysis and Statistical Interpretation lab at Vanderbilt`_
+ *[us-tn]*
+
+ If your are interested in mirroring the repository, please see the :ref:`faq`.
+
+.. _Department of Psychological and Brain Sciences at Dartmouth College: http://www.dartmouth.edu/~psych
+.. _Department of Experimental Psychology at the University of Magdeburg: http://apsy.gse.uni-magdeburg.de
+.. _Neurobot at Aristotle University of Thessaloniki, Greece: http://neurobot.bio.auth.gr
+.. _Paul Ivanov: http://www.pirsquared.org
+.. _Medical-image Analysis and Statistical Interpretation lab at Vanderbilt: https://masi.vuse.vanderbilt.edu
+
Once this is done, you have to update the package index. Use your favorite
package manager, e.g. synaptic, adept, or whatever you like. In the terminal
you can use :command:`aptitude` to achieve the same::
about which package version is available for which release and architecture,
please have a look at the corresponding package pages.
+After this initial setup you probably also want to configure your package
+manager to recognize the NeuroDebian archive key. With this key the package
+manager can verify that packages haven't been modified and are identical with
+the ones in the main NeuroDebian archive, regardless of which mirror you
+downloaded them from. The NeuroDebian key id is **2649A5A9**. If you need further
+help setting up package authentication, please take a look at
+:ref:`corresponding FAQ <sec_pkg_authentication>`.
+
+
+.. _chap_installation:
+
+Ways to use NeuroDebian
+=======================
+
+Virtual machine
+---------------
+
+If you are not running Debian_ on a particular machine a :ref:`chap_vm` is
+provided as a convenient testing and evaluation environment. After a few
+simple steps to setup the virtual machine, you will be able to use NeuroDebian_
+as an integral part of your existing working environment without any sacrifice.
+The virtual machine is also a suitable environment to temporarily deploy
+neuroscience software on machines running other operating systems, e.g. for the
+purpose of teaching a neuroimaging data analysis course in a multipurpose
+computer lab.
+
+
+Debian installation
+-------------------
+
+Having been exposed to the wonders of NeuroDebian_ you are no longer
+satisfied with your previous choice of operating system? We would
+recommend installing Debian_ to replace or complement (dual-boot) your
+existing OS. Please visit `"Getting Debian"
+<http://www.debian.org/distrib/>`_ to obtain the images for your
+hardware architecture and then simply add |repos|.
+
+
+.. _chap_team:
+
+
+The team
+========
+
+Our main goal is to provide neuroscience FOSS_ for Debian_. Thus the
+whole project would not be possible without the work of over 3,000
+Debian_ developers and contributors who are as enthusiastically pursuing
+a similar goal. To add our share -- Debian_ packages of FOSS_ for
+neuroscience research -- the `Experimental Psychology Debian packaging
+project <http://alioth.debian.org/projects/pkg-exppsy>`_ was created
+to formally join the forces of
+
+* `Michael Hanke <http://mih.voxindeserto.de>`_
+* `Yaroslav Halchenko <http://www.onerussian.com>`_
+
+A number of packages that are now available from the NeuroDebian repository
+were not packaged by our team, but similar Debian teams. Therefore we want to
+express particular gratitude to the `Debian Med`_ and `Debian Science`_ teams
+for all their work.
+
+.. _FOSS: http://en.wikipedia.org/wiki/Free_and_open_source_software
+
+
+Contacts
+========
+
+`Email us directly <team@neuro.debian.net>`_ with any "private"
+communication. Otherwise please use our public mailing lists, which
+exist not only to provide user-support but also to establish
+communication channels within the NeuroDebian community
+
+* neurodebian-users_: Discussions and support of NeuroDebian users
+
+* neurodebian-upstream_: General discussions and knowledge sharing
+ among developers of the neuroscience software. We will also use it
+ to update you with summaries of recent relevant developments in
+ Debian project
+
+* neurodebian-devel_: Technical mailing list for discussions on
+ NeuroDebian development
-Package authentication
-----------------------
+.. _neurodebian-users: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-users
+.. _neurodebian-devel: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-devel
+.. _neurodebian-upstream: http://lists.alioth.debian.org/mailman/listinfo/neurodebian-upstream
-When you start using this repository, you probably get warning messages
-like this::
- The following signatures couldn't be verified because
- the public key is not available.`
+Acknowledgements
+================
-Or you will be asked questions like this over and over::
+We are grateful to Jim Haxby for his continued support and :ref:`endless supply of
+Italian espresso <coffeeart>`.
- WARNING: The following packages cannot be authenticated!
- ...
- Install these packages without verification [y/N]?
-This is because your APT installation initially does not know the GPG
-key that is used to sign the release files of this repository. Making
-APT happy again is easy:
+.. toctree::
+ :hidden:
-1. Get the key. Either download the `repository key from here
- <_static/apsy.gse.uni-magdeburg.de.asc>`_
- or fetch it from *subkeys.pgp.net* (2649A5A9).
+ faq
+ pkgs
+ spread
+ vm
+ coffeeart
+ testimonials
-2. Now feed the key into APT by invoking::
+.. probably should be purged altogether
+.. toctree::
+ :hidden:
- apt-key add #file#
+ livecd
+ gpg
+ setup
+ links_names
+ substitutions
+ quotes-nihr01
+ quotes-nitrc
- Where `#file#` has to be replaced with the location of the key file you just
- downloaded. You need to have superuser-privileges to do this (either do it
- as root or use sudo).
+.. include:: links_names.rst
+.. include:: substitutions.rst