sphinx/faq.rst

   1 .. -*- mode: rst; fill-column: 78 -*-
   2 .. ex: set sts=4 ts=4 sw=4 et tw=79:
   3
   4
   5 .. _faq:
   6
   7 **************************
   8 Frequently Asked Questions
   9 **************************
  10
  11 Why NeuroDebian?
  12 ----------------
  13
  14   In the course of our own research endeavors |we| have joined forces to
  15   develop `PyMVPA -- a Python framework for multivariate pattern analysis of
  16   neural data <http://www.pymvpa.org>`_.  To conveniently deployment PyMVPA for
  17   anyone using Debian-derived distributions this package repository was created
  18   initially.  Besides the PyMVPA_ project |we| collaborate with the `NiPy team
  19   <http://neuroimaging.scipy.org>`_ on various projects, such as NiBabel_ and
  20   NiPype_.  Quickly NeuroDebian_ became the ultimate integrated environment for
  21   all these projects. We are now constantly working on enriching this
  22   environment with as many additional relevant software as possible.
  23
  24
  25 Why is NeuroDebian not a Pure Blend?
  26 ------------------------------------
  27
  28   Because there is no need for it to become one, as the existing Debian Pure
  29   Blends already offer the desired functionality *within* Debian. Similar to
  30   Pure Blends, NeuroDebian's goal is to provide software for neuroscientists
  31   using the Debian operating system, and therefore the ultimate goal is to get
  32   all relevant software **into Debian**.
  33
  34   However, various reasons exist that prevent a particular software from
  35   entering Debian. Some are temporary, i.e. a package is already useable, but
  36   some technical bits do not meet Debian's standards (yet) or a licensing issue
  37   needs to be resolved first. For some software the licensing is so restrictive
  38   that it cannot be distributed by Debian, and hence cannot even go into its
  39   *non-free* branch. Unfortunately, sometimes these issues cannot be solved to
  40   a degree that is acceptable for Debian. For some other packages Debian itself
  41   is not ready yet, e.g. huge data packages with neuroscience data (:ref:`with
  42   sometimes over 1GB <pkg_fsl-first-data>`).
  43
  44   NeuroDebian aims to be a platform that provides a staging area for
  45   neuroscience software packages on their way into Debian. All packages are
  46   properly registered with the relevant `Debian Pure Blends`_, e.g.
  47   `Debian Science Cognitive Neuroscience`_ or `Debian Med Imaging`_. Inside
  48   Debian these efforts already provide a suitable framework for this purpose,
  49   and hence there is no need to establish yet another one.
  50
  51 .. _Debian Pure Blends: http://wiki.debian.org/DebianPureBlends
  52 .. _Debian Science Cognitive Neuroscience: http://blends.alioth.debian.org/science/tasks/neuroscience-cognitive
  53 .. _Debian Med Imaging: http://debian-med.alioth.debian.org/tasks/imaging
  54
  55
  56 When does a package migrate from NeuroDebian into Debian proper?
  57 ----------------------------------------------------------------
  58
  59   In short: When it is ready. The longer answer is that there is nothing
  60   special to packages in NeuroDebian in comparison to packages conducted
  61   elsewhere.  Packaging efforts are announced to Debian via ITPs_ and the
  62   packaging itself is available in some version control system -- typically in
  63   the Git repositories of the `pkg-exppsy group on Debian's Alioth server`_, or
  64   another VCS, or on http://mentors.debian.net.
  65
  66   The only difference is that a particular package becomes available through the
  67   NeuroDebian repository before it has passed all checks for compliance with
  68   Debian's standards. But even after a package becomes part of Debian the
  69   NeuroDebian repository continues to provide binary packages of new versions
  70   for a certain set of Debian and Ubuntu releases (aka backports).
  71
  72 .. _ITPs: http://www.debian.org/devel/wnpp
  73 .. _pkg-exppsy group on Debian's Alioth server: http://alioth.debian.org/projects/pkg-exppsy/
  74
  75
  76 Debian, Debian, Debian -- What about Ubuntu?
  77 --------------------------------------------
  78
  79   NeuroDebian offers backported binary packages for recent Ubuntu releases
  80   whenever possible. However, since Ubuntu (like many other derivatives) uses
  81   Debian as its foundation, it is more efficient to spend time maintaining
  82   packages in Debian, instead of having to directly contribute to countless
  83   child-distributions.  After the appearance of new packages in Debian, Ubuntu
  84   typically synchronizes them quickly and they become available in the *Ubuntu
  85   universe* -- a repository of Debian packages rebuilt for a particular Ubuntu
  86   release.  We are not constantly rebuilding of all available NeuroDebian
  87   packages for new Ubuntu releases.  Therefore, you might find some packages
  88   temporarily being available for older Ubuntu releases only -- until the point
  89   when a new package version is made and gets built for all currently supported
  90   releases.
  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 The goal of NeuroDebian is to package neuroscience software for Debian. Hence
 105 getting software into NeuroDebian means trying to get it into Debian. There are
 106 at least two possibilities to achieve that:
 107
 108 * You can approach packaging it yourself. Start by filing an ITP_ (Intent to
 109   package) bugreport) and `ask us <team@neuro.debian.net>`_ to mentor your
 110   upload to Debian_, if you are not a Debian developer.
 111
 112 * `Contact us <team@neuro.debian.net>`_ -- but then it might take a little
 113   longer, depending on our current workload and interest in a particular
 114   software.
 115
 116
 117 I have heard that some packages are non-free. Will you charge me for them?
 118 --------------------------------------------------------------------------
 119
 120   No. The term :term:`non-free` refers to an archive section. NeuroDebian uses
 121   exactly the same :ref:`archive sections as Debian proper
 122   <http://www.debian.org/doc/debian-policy/ch-archive.html>`.  The *non-free*
 123   section contains packages that have certain restrictions regarding **your
 124   freedom** to employ them for a particular purpose. In contrast, for packages
 125   in the *main* section your are completely free to do whatever and in whatever
 126   context you like. Regardless of the actual license or archive section, all
 127   packages in NeuroDebian are provided free of charge and under the licensing
 128   terms of the original developers.
 129
 130 .. _sec_pkg_authentication:
 131
 132 What means "The following signatures couldn't be verified..."?
 133 --------------------------------------------------------------
 134
 135 When you start using this repository, you probably get warning messages
 136 like this::
 137
 138   The following signatures couldn't be verified because
 139   the public key is not available.
 140
 141 Or you will be asked questions like this over and over::
 142
 143   WARNING: The following packages cannot be authenticated!
 144   ...
 145   Install these packages without verification [y/N]?
 146
 147 This is because your APT installation initially does not know the GPG
 148 key that is used to sign the release files of this repository. It is easy to
 149 make APT happy again. The simplest way is to install the ``neurodebian-keyring``
 150 package that is available from the NeuroDebian repository. Alternatively:
 151
 152 1. Get the key. Either download the `repository key from here
 153    <_static/neuro.debian.net.asc>`_
 154    or fetch it from http://wwwkeys.pgp.net (2649A5A9).
 155
 156 2. Now feed the key into APT by invoking::
 157
 158      apt-key add #file#
 159
 160    Where `#file#` has to be replaced with the location of the key file you just
 161    downloaded. You need to have superuser-privileges to do this (either do it
 162    as root or use sudo).
 163
 164
 165 .. include:: link_names.txt
 166 .. include:: substitutions.txt