]> git.donarmstrong.com Git - neurodebian.git/blobdiff - sphinx/faq.rst
testimonial from Sebastian
[neurodebian.git] / sphinx / faq.rst
index 85753bd27f16f93689a8b059a41f61934c079b07..4757ecad9b27e12ddf04a6b7c5721ab33d5238c1 100644 (file)
@@ -1,11 +1,5 @@
 .. -*- mode: rst; fill-column: 78 -*-
 .. ex: set sts=4 ts=4 sw=4 et tw=79:
-  ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
-  #
-  #   See COPYING file distributed along with the PyMVPA package for the
-  #   copyright and license terms.
-  #
-  ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
 
 
 .. _faq:
@@ -17,21 +11,21 @@ Frequently Asked Questions
 Why NeuroDebian?
 ----------------
 
-  In the course of our research endeavors |we| have joined the forces to
-  develop a `PyMVPA -- Python framework for multivariate pattern analysis of
-  neural data <http://www.pymvpa.org>`_.  To provide convenient deployment for
-  anyone using Debian-derived distribution this package repository was
-  created.  Besides PyMVPA_ project |we| collaborate with `NiPy team
+  In the course of our own research endeavors |we| have joined forces to
+  develop `PyMVPA -- a Python framework for multivariate pattern analysis of
+  neural data <http://www.pymvpa.org>`_.  To conveniently deploy PyMVPA for
+  anyone using Debian-derived distributions this package repository was created
+  initially.  Besides the PyMVPA_ project |we| collaborate with the `NiPy team
   <http://neuroimaging.scipy.org>`_ on various projects, such as NiBabel_ and
-  NiPype_.  Quickly NeuroDebian_ became our ultimate delivery mechanism for
-  all the projects we develop and package, so they are readily available for
-  deployment.
+  NiPype_.  Quickly NeuroDebian_ became the ultimate integrated environment for
+  all these projects -- and we are constantly working on enriching this
+  environment with as many additional relevant software as possible.
 
 
 Why is NeuroDebian not a Pure Blend?
 ------------------------------------
 
-  Because there is not need for it to become one, as the existing Debian Pure
+  Because there is no need for it to become one, as the existing Debian Pure
   Blends already offer the desired functionality *within* Debian. Similar to
   Pure Blends, NeuroDebian's goal is to provide software for neuroscientists
   using the Debian operating system, and therefore the ultimate goal is to get
@@ -39,7 +33,7 @@ Why is NeuroDebian not a Pure Blend?
 
   However, various reasons exist that prevent a particular software from
   entering Debian. Some are temporary, i.e. a package is already useable, but
-  some technical bits do not meet Debian's standard yet or a licensing issue
+  some technical bits do not meet Debian's standards (yet) or a licensing issue
   needs to be resolved first. For some software the licensing is so restrictive
   that it cannot be distributed by Debian, and hence cannot even go into its
   *non-free* branch. Unfortunately, sometimes these issues cannot be solved to
@@ -49,7 +43,7 @@ Why is NeuroDebian not a Pure Blend?
 
   NeuroDebian aims to be a platform that provides a staging area for
   neuroscience software packages on their way into Debian. All packages are
-  properly registered with the relevant `Debian Pure Blends`_, e.g.
+  properly registered in the relevant `Debian Pure Blends`_, e.g.
   `Debian Science Cognitive Neuroscience`_ or `Debian Med Imaging`_. Inside
   Debian these efforts already provide a suitable framework for this purpose,
   and hence there is no need to establish yet another one.
@@ -59,6 +53,18 @@ Why is NeuroDebian not a Pure Blend?
 .. _Debian Med Imaging: http://debian-med.alioth.debian.org/tasks/imaging
 
 
+I want to help. How do I get involved?
+--------------------------------------
+
+  We always need people to help maintaining existing packages. If you need
+  some additional software packaged and you want to try it on your own, we would
+  be happy to mentor you. We also have a :ref:`list of ongoing and planned
+  projects <projects>`, each listing a number of tasks that need to be done.
+
+  If you found something you are interested in, please email the
+  neurodebian-devel_ mailing list and let us know about it. Thanks!
+
+
 When does a package migrate from NeuroDebian into Debian proper?
 ----------------------------------------------------------------
 
@@ -83,11 +89,17 @@ Debian, Debian, Debian -- What about Ubuntu?
 --------------------------------------------
 
   NeuroDebian offers backported binary packages for recent Ubuntu releases
-  whenever possible. However, since Ubuntu is a rather thin shell around Debian
-  it is more efficient to spend time packaging for Debian. After the appearance
-  of new packages in Debian, Ubuntu typically synchronizes them quickly and
-  they become available in the *Ubuntu universe* -- a repository of Debian
-  packages rebuilt for a particular Ubuntu release.
+  whenever possible. However, since Ubuntu (like many other derivatives) uses
+  Debian as its foundation, it is more efficient to spend time maintaining
+  packages in Debian, instead of having to directly contribute to countless
+  child-distributions.  After the appearance of new packages in Debian, Ubuntu
+  typically synchronizes them quickly and they become available in the *Ubuntu
+  universe* -- a repository of Debian packages rebuilt for a particular Ubuntu
+  release.  We are not constantly rebuilding of all available NeuroDebian
+  packages for new Ubuntu releases.  Therefore, you might find some packages
+  temporarily being available for older Ubuntu releases only -- until the point
+  when a new package version is made and gets built for all currently supported
+  releases.
 
 
 How to create a mirror of the repository?
@@ -101,13 +113,77 @@ How to create a mirror of the repository?
 How do I get a new neuroscience-related FOSS into (Neuro)Debian?
 ----------------------------------------------------------------
 
-  * You can approach packaging it yourself (file an ITP_ (Intent to package)
-    bugreport) and `ask us <team@neuro.debian.net>`_ to mentor your upload to
-    Debian_ if you are not a Debian developer.
+The goal of NeuroDebian is to package neuroscience software for Debian. Hence
+getting software into NeuroDebian means trying to get it into Debian. There are
+at least two possibilities to achieve that:
+
+* You can approach packaging it yourself. Start by filing an ITP_ (Intent to
+  package) bugreport) and `ask us <team@neuro.debian.net>`_ to mentor your
+  upload to Debian_, if you are not a Debian developer.
+
+* `Contact us <team@neuro.debian.net>`_ -- but then it might take a little
+  longer, depending on our current workload and interest in a particular
+  software.
+
+
+I have heard that some packages are non-free. Will you charge me for them?
+--------------------------------------------------------------------------
+
+  No. The term :term:`non-free` refers to an archive section. NeuroDebian uses
+  exactly the same `archive sections as Debian proper
+  <http://www.debian.org/doc/debian-policy/ch-archive.html>`_.  The *non-free*
+  section contains packages that have certain restrictions regarding **your
+  freedom** to employ them for a particular purpose. In contrast, for packages
+  in the *main* section your are completely free to do whatever and in whatever
+  context you like. Regardless of the actual license or archive section, all
+  packages in NeuroDebian are provided free of charge and under the licensing
+  terms of the original developers.
+
+.. _sec_pkg_authentication:
+
+What means "The following signatures couldn't be verified..."?
+--------------------------------------------------------------
+
+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.
+
+Or you will be asked questions like this over and over::
+
+  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. It is easy to
+make APT happy again. The simplest way is to install the ``neurodebian-keyring``
+package that is available from the NeuroDebian repository. Alternatively:
+
+1. Get the key. Either download the `repository key from here
+   <_static/neuro.debian.net.asc>`_
+   or fetch it from http://wwwkeys.pgp.net (2649A5A9).
+
+2. Now feed the key into APT by invoking::
+
+     apt-key add #file#
+
+   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).
+
+
+How can I cite NeuroDebian?
+---------------------------
+
+Please cite the following paper:
 
-  * `Contact us <team@neuro.debian.net>`_, but then it might take longer
-    depending on our workload and interest to the particular software.
+  Halchenko, Y. O. & Hanke, M. (2012). `Open is not enough. Let’s take the
+  next step: An integrated, community-driven computing platform for neuroscience
+  <http://www.frontiersin.org/Neuroinformatics/10.3389/fninf.2012.00022/full>`_.
+  *Frontiers in Neuroinformatics*, 6:22.
 
 
-.. include:: links_names.rst
-.. include:: substitutions.rst
+.. include:: link_names.txt
+.. include:: substitutions.txt