]> git.donarmstrong.com Git - neurodebian.git/blobdiff - sphinx/faq.rst
Reduce use of 'raw:: html' and do native RST
[neurodebian.git] / sphinx / faq.rst
index 956de0ea133552ffe6fb4c70db2bdf95165e401d..1249930f1703853127d93216d9c3b18070a0f866 100644 (file)
@@ -8,28 +8,30 @@
 Frequently Asked Questions
 **************************
 
-Why NeuroDebian?
-----------------
+.. raw:: html
+
+  <div class="expandinstructions">Click on an item to expand it</div>
 
+Why NeuroDebian?
   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 deployment PyMVPA for
+  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 the ultimate integrated environment for
-  all these projects. We are now constantly working on enriching this
+  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?
-------------------------------------
+  This is in the works, but...
 
-  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
-  all relevant software **into Debian**.
+  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 all
+  relevant software **into Debian**.
 
   However, various reasons exist that prevent a particular software from
   entering Debian. Some are temporary, i.e. a package is already useable, but
@@ -43,7 +45,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.
@@ -53,9 +55,17 @@ Why is NeuroDebian not a Pure Blend?
 .. _Debian Med Imaging: http://debian-med.alioth.debian.org/tasks/imaging
 
 
-When does a package migrate from NeuroDebian into Debian proper?
-----------------------------------------------------------------
+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?
   In short: When it is ready. The longer answer is that there is nothing
   special to packages in NeuroDebian in comparison to packages conducted
   elsewhere.  Packaging efforts are announced to Debian via ITPs_ and the
@@ -74,8 +84,6 @@ When does a package migrate from NeuroDebian into Debian proper?
 
 
 Debian, Debian, Debian -- What about Ubuntu?
---------------------------------------------
-
   NeuroDebian offers backported binary packages for recent Ubuntu releases
   whenever possible. However, since Ubuntu (like many other derivatives) uses
   Debian as its foundation, it is more efficient to spend time maintaining
@@ -91,35 +99,29 @@ Debian, Debian, Debian -- What about Ubuntu?
 
 
 How to create a mirror of the repository?
------------------------------------------
-
   The NeuroDebian repository can be mirrored with rsync. If you are interested
   in sponsoring storage space and bandwidth for another mirror, please
   `contact us <team@neuro.debian.net>`_.
 
 
 How do I get a new neuroscience-related FOSS into (Neuro)Debian?
-----------------------------------------------------------------
-
-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:
+  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.
+  * 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.
+  * `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 :ref:`archive sections as Debian proper
-  <http://www.debian.org/doc/debian-policy/ch-archive.html>`.  The *non-free*
+  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
@@ -130,36 +132,43 @@ I have heard that some packages are non-free. Will you charge me for them?
 .. _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::
 
-When you start using this repository, you probably get warning messages
-like this::
+    WARNING: The following packages cannot be authenticated!
+    ...
+    Install these packages without verification [y/N]?
 
-  The following signatures couldn't be verified because
-  the public key is not available.
+  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:
 
-Or you will be asked questions like this over and over::
+  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).
 
-  WARNING: The following packages cannot be authenticated!
-  ...
-  Install these packages without verification [y/N]?
+  2. Now feed the key into APT by invoking::
 
-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:
+       apt-key add #file#
 
-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).
+     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).
 
-2. Now feed the key into APT by invoking::
 
-     apt-key add #file#
+How can I cite NeuroDebian?
+  Please cite the following paper:
 
-   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).
+  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:: link_names.txt