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 own research endeavors |we| have joined forces to
  21   develop `PyMVPA -- a Python framework for multivariate pattern analysis of
  22   neural data <http://www.pymvpa.org>`_.  To conveniently deployment PyMVPA for
  23   anyone using Debian-derived distributions this package repository was created
  24   initially.  Besides the PyMVPA_ project |we| collaborate with the `NiPy team
  25   <http://neuroimaging.scipy.org>`_ on various projects, such as NiBabel_ and
  26   NiPype_.  Quickly NeuroDebian_ became the ultimate integrated environment for
  27   all these projects. We are now constantly working on enriching this
  28   environment with as many additional relevant software as possible.
  29
  30
  31 Why is NeuroDebian not a Pure Blend?
  32 ------------------------------------
  33
  34   Because there is no 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 standards (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 (like many other derivatives) uses
  87   Debian as its foundation, it is more efficient to spend time maintaining
  88   packages in Debian, instead of having to directly contribute to countless
  89   child-distributions.  After the appearance of new packages in Debian, Ubuntu
  90   typically synchronizes them quickly and they become available in the *Ubuntu
  91   universe* -- a repository of Debian packages rebuilt for a particular Ubuntu
  92   release.  We are not constantly rebuilding of all available NeuroDebian
  93   packages for new Ubuntu releases.  Therefore, you might find some packages
  94   temporarily being available for older Ubuntu releases only -- until the point
  95   when a new package version is made and gets built for all currently supported
  96   releases.
  97
  98
  99 How to create a mirror of the repository?
 100 -----------------------------------------
 101
 102   The NeuroDebian repository can be mirrored with rsync. If you are interested
 103   in sponsoring storage space and bandwidth for another mirror, please
 104   `contact us <team@neuro.debian.net>`_.
 105
 106
 107 How do I get a new neuroscience-related FOSS into (Neuro)Debian?
 108 ----------------------------------------------------------------
 109
 110   * You can approach packaging it yourself (file an ITP_ (Intent to package)
 111     bugreport) and `ask us <team@neuro.debian.net>`_ to mentor your upload to
 112     Debian_ if you are not a Debian developer.
 113
 114   * `Contact us <team@neuro.debian.net>`_, but then it might take longer
 115     depending on our workload and interest to the particular software.
 116
 117
 118 I have heard that some packages are non-free. Will you charge me for them?
 119 --------------------------------------------------------------------------
 120
 121   No. The term :term:`non-free` refers to an archive section. NeuroDebian uses
 122   exactly the same :ref:`archive sections as Debian proper
 123   <http://www.debian.org/doc/debian-policy/ch-archive.html>`.  The *non-free*
 124   section contains packages that have certain restrictions regarding **your
 125   freedom** to employ them for a particular purpose. In contrast, for packages
 126   in the *main* section your are completely free to do whatever and in whatever
 127   context you like. Regardless of the actual license or archive section, all
 128   packages in NeuroDebian are provided free of charge and under the licensing
 129   terms of the original developers.
 130
 131
 132 .. include:: links_names.rst
 133 .. include:: substitutions.rst