sphinx/faq.rst

   1 .. -*- mode: rst; fill-column: 78 -*-
   2 .. ex: set sts=4 ts=4 sw=4 et tw=79:
   3   ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
   4   #
   5   #   See COPYING file distributed along with the PyMVPA package for the
   6   #   copyright and license terms.
   7   #
   8   ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
   9
  10
  11 .. _faq:
  12
  13 **************************
  14 Frequently Asked Questions
  15 **************************
  16
  17 Why NeuroDebian?
  18 ----------------
  19
  20   In the course of our research endeavors |we| have joined the forces to
  21   develop a `PyMVPA -- Python framework for multivariate pattern analysis of
  22   neural data <http://www.pymvpa.org>`_.  To provide convenient deployment for
  23   anyone using Debian-derived distribution this package repository was
  24   created.  Besides PyMVPA_ project |we| collaborate with `NiPy team
  25   <http://neuroimaging.scipy.org>`_ on various projects, such as NiBabel_ and
  26   NiPype_.  Quickly NeuroDebian_ became our ultimate delivery mechanism for
  27   all the projects we develop and package, so they are readily available for
  28   deployment.
  29
  30
  31 Why is NeuroDebian not a Pure Blend?
  32 ------------------------------------
  33
  34   Because there is not need for it to become one, as the existing Debian Pure
  35   Blends already offer the desired functionality *within* Debian. Similar to
  36   Pure Blends, NeuroDebian's goal is to provide software for neuroscientists
  37   using the Debian operating system, and therefore the ultimate goal is to get
  38   all relevant software **into Debian**.
  39
  40   However, various reasons exist that prevent a particular software from
  41   entering Debian. Some are temporary, i.e. a package is already useable, but
  42   some technical bits do not meet Debian's standard yet or a licensing issue
  43   needs to be resolved first. For some software the licensing is so restrictive
  44   that it cannot be distributed by Debian, and hence cannot even go into its
  45   *non-free* branch. Unfortunately, sometimes these issues cannot be solved to
  46   a degree that is acceptable for Debian. For some other packages Debian itself
  47   is not ready yet, e.g. huge data packages with neuroscience data (:ref:`with
  48   sometimes over 1GB <pkg_fsl-first-data>`).
  49
  50   NeuroDebian aims to be a platform that provides a staging area for
  51   neuroscience software packages on their way into Debian. All packages are
  52   properly registered with the relevant `Debian Pure Blends`_, e.g.
  53   `Debian Science Cognitive Neuroscience`_ or `Debian Med Imaging`_. Inside
  54   Debian these efforts already provide a suitable framework for this purpose,
  55   and hence there is no need to establish yet another one.
  56
  57 .. _Debian Pure Blends: http://wiki.debian.org/DebianPureBlends
  58 .. _Debian Science Cognitive Neuroscience: http://blends.alioth.debian.org/science/tasks/neuroscience-cognitive
  59 .. _Debian Med Imaging: http://debian-med.alioth.debian.org/tasks/imaging
  60
  61
  62 When does a package migrate from NeuroDebian into Debian proper?
  63 ----------------------------------------------------------------
  64
  65   In short: When it is ready. The longer answer is that there is nothing
  66   special to packages in NeuroDebian in comparison to packages conducted
  67   elsewhere.  Packaging efforts are announced to Debian via ITPs_ and the
  68   packaging itself is available in some version control system -- typically in
  69   the Git repositories of the `pkg-exppsy group on Debian's Alioth server`_, or
  70   another VCS, or on http://mentors.debian.net.
  71
  72   The only difference is that a particular package becomes available through the
  73   NeuroDebian repository before it has passed all checks for compliance with
  74   Debian's standards. But even after a package becomes part of Debian the
  75   NeuroDebian repository continues to provide binary packages of new versions
  76   for a certain set of Debian and Ubuntu releases (aka backports).
  77
  78 .. _ITPs: http://www.debian.org/devel/wnpp
  79 .. _pkg-exppsy group on Debian's Alioth server: http://alioth.debian.org/projects/pkg-exppsy/
  80
  81
  82 Debian, Debian, Debian -- What about Ubuntu?
  83 --------------------------------------------
  84
  85   NeuroDebian offers backported binary packages for recent Ubuntu releases
  86   whenever possible. However, since Ubuntu is a rather thin shell around Debian
  87   it is more efficient to spend time packaging for Debian. After the appearance
  88   of new packages in Debian, Ubuntu typically synchronizes them quickly and
  89   they become available in the *Ubuntu universe* -- a repository of Debian
  90   packages rebuilt for a particular Ubuntu release.
  91
  92
  93 How to create a mirror of the repository?
  94 -----------------------------------------
  95
  96   The NeuroDebian repository can be mirrored with rsync. If you are interested
  97   in sponsoring storage space and bandwidth for another mirror, please
  98   `contact us <team@neuro.debian.net>`_.
  99
 100
 101 How do I get a new neuroscience-related FOSS into (Neuro)Debian?
 102 ----------------------------------------------------------------
 103
 104   * You can approach packaging it yourself (file an ITP_ (Intent to package)
 105     bugreport) and `ask us <team@neuro.debian.net>`_ to mentor your upload to
 106     Debian_ if you are not a Debian developer.
 107
 108   * `Contact us <team@neuro.debian.net>`_, but then it might take longer
 109     depending on our workload and interest to the particular software.
 110
 111
 112 .. include:: links_names.rst
 113 .. include:: substitutions.rst