]> git.donarmstrong.com Git - neurodebian.git/blobdiff - sphinx/index.rst
Some design tweaks; separate icon for datasets.
[neurodebian.git] / sphinx / index.rst
index 20d29d877207c13aef39dd9f0f3c3d1958ba2aea..9c61985c217e0cf193561c0272fd537fc3aa8d88 100644 (file)
@@ -1,24 +1,77 @@
+.. _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.
+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.
+
+.. raw:: html
+
+ <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
+====
+
+.. raw:: html
+
+ <script src="http://widgets.twimg.com/j/2/widget.js"></script>
+ <script>
+ new TWTR.Widget({
+   version: 2,
+   type: 'profile',
+   rpp: 10,
+   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
 
-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. All featured neuroscience software
-packages are available from the :ref:`full package list <full_pkg_list>`.
+.. _repository_howto:
 
 
-.. _repository_howto:
 
 How to use this repository
 ==========================
@@ -35,6 +88,24 @@ 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]`
+  * `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
+.. _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::
@@ -57,8 +128,8 @@ Package authentication
 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.`
+  The following signatures couldn't be verified because
+  the public key is not available.
 
 Or you will be asked questions like this over and over::
 
@@ -67,12 +138,12 @@ Or you will be asked questions like this over and over::
   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:
+key that is used to sign the release files of this repository. It is easy to
+make APT happy again:
 
 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).
+   <_static/neuro.debian.net.asc>`_
+   or fetch it from http://wwwkeys.pgp.net (2649A5A9).
 
 2. Now feed the key into APT by invoking::
 
@@ -81,3 +152,102 @@ APT happy again is easy:
    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).
+
+
+.. _chap_installation:
+
+Installation
+============
+
+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
+------
+
+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
+
+.. _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
+
+
+.. toctree::
+   :hidden:
+
+   faq
+   pkgs
+   spread
+   vm
+
+.. probably should be purged altogether
+.. toctree::
+   :hidden:
+
+   livecd
+   gpg
+   setup
+   links_names
+   substitutions
+
+.. include:: links_names.rst
+.. include:: substitutions.rst