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   In the course of our own research endeavors |we| have joined forces to
  13   develop `PyMVPA -- a Python framework for multivariate pattern analysis of
  14   neural data <http://www.pymvpa.org>`_.  To conveniently deploy PyMVPA for
  15   anyone using Debian-derived distributions this package repository was created
  16   initially.  Besides the PyMVPA_ project |we| collaborate with the `NiPy team
  17   <http://neuroimaging.scipy.org>`_ on various projects, such as NiBabel_ and
  18   NiPype_.  Quickly NeuroDebian_ became the ultimate integrated environment for
  19   all these projects -- and we are constantly working on enriching this
  20   environment with as many additional relevant software as possible.
  21
  22
  23 Why is NeuroDebian not a Pure Blend?
  24   This is in the works, but...
  25
  26   There is no need for it to become one, as the existing Debian Pure Blends
  27   already offer the desired functionality *within* Debian. Similar to Pure
  28   Blends, NeuroDebian's goal is to provide software for neuroscientists using
  29   the Debian operating system, and therefore the ultimate goal is to get all
  30   relevant software **into Debian**.
  31
  32   However, various reasons exist that prevent a particular software from
  33   entering Debian. Some are temporary, i.e. a package is already useable, but
  34   some technical bits do not meet Debian's standards (yet) or a licensing issue
  35   needs to be resolved first. For some software the licensing is so restrictive
  36   that it cannot be distributed by Debian, and hence cannot even go into its
  37   *non-free* branch. Unfortunately, sometimes these issues cannot be solved to
  38   a degree that is acceptable for Debian. For some other packages Debian itself
  39   is not ready yet, e.g. huge data packages with neuroscience data (:ref:`with
  40   sometimes over 1GB <pkg_fsl-first-data>`).
  41
  42   NeuroDebian aims to be a platform that provides a staging area for
  43   neuroscience software packages on their way into Debian. All packages are
  44   properly registered in the relevant `Debian Pure Blends`_, e.g.
  45   `Debian Science Cognitive Neuroscience`_ or `Debian Med Imaging`_. Inside
  46   Debian these efforts already provide a suitable framework for this purpose,
  47   and hence there is no need to establish yet another one.
  48
  49 .. _Debian Pure Blends: http://wiki.debian.org/DebianPureBlends
  50 .. _Debian Science Cognitive Neuroscience: http://blends.alioth.debian.org/science/tasks/neuroscience-cognitive
  51 .. _Debian Med Imaging: http://debian-med.alioth.debian.org/tasks/imaging
  52
  53
  54 I want to help. How do I get involved?
  55   We always need people to help maintaining existing packages. If you need
  56   some additional software packaged and you want to try it on your own, we would
  57   be happy to mentor you. We also have a :ref:`list of ongoing and planned
  58   projects <projects>`, each listing a number of tasks that need to be done.
  59
  60   If you found something you are interested in, please email the
  61   neurodebian-devel_ mailing list and let us know about it. Thanks!
  62
  63
  64 When does a package migrate from NeuroDebian into Debian proper?
  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   NeuroDebian offers backported binary packages for recent Ubuntu releases
  84   whenever possible. However, since Ubuntu (like many other derivatives) uses
  85   Debian as its foundation, it is more efficient to spend time maintaining
  86   packages in Debian, instead of having to directly contribute to countless
  87   child-distributions.  After the appearance of new packages in Debian, Ubuntu
  88   typically synchronizes them quickly and they become available in the *Ubuntu
  89   universe* -- a repository of Debian packages rebuilt for a particular Ubuntu
  90   release.  We are not constantly rebuilding of all available NeuroDebian
  91   packages for new Ubuntu releases.  Therefore, you might find some packages
  92   temporarily being available for older Ubuntu releases only -- until the point
  93   when a new package version is made and gets built for all currently supported
  94   releases.
  95
  96
  97 How to create a mirror of the repository?
  98   The NeuroDebian repository can be mirrored with rsync. If you are interested
  99   in sponsoring storage space and bandwidth for another mirror, please
 100   `contact us <team@neuro.debian.net>`_.
 101
 102
 103 How do I get a new neuroscience-related FOSS into (Neuro)Debian?
 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   No. The term :term:`non-free` refers to an archive section. NeuroDebian uses
 119   exactly the same `archive sections as Debian proper
 120   <http://www.debian.org/doc/debian-policy/ch-archive.html>`_.  The *non-free*
 121   section contains packages that have certain restrictions regarding **your
 122   freedom** to employ them for a particular purpose. In contrast, for packages
 123   in the *main* section your are completely free to do whatever and in whatever
 124   context you like. Regardless of the actual license or archive section, all
 125   packages in NeuroDebian are provided free of charge and under the licensing
 126   terms of the original developers.
 127
 128 .. _sec_pkg_authentication:
 129
 130 What means "The following signatures couldn't be verified..."?
 131   When you start using this repository, you probably get warning messages
 132   like this::
 133
 134     The following signatures couldn't be verified because
 135     the public key is not available.
 136
 137   Or you will be asked questions like this over and over::
 138
 139     WARNING: The following packages cannot be authenticated!
 140     ...
 141     Install these packages without verification [y/N]?
 142
 143   This is because your APT installation initially does not know the GPG
 144   key that is used to sign the release files of this repository. It is easy to
 145   make APT happy again. The simplest way is to install the ``neurodebian-keyring``
 146   package that is available from the NeuroDebian repository. Alternatively:
 147
 148   1. Get the key. Either download the `repository key from here
 149      <_static/neuro.debian.net.asc>`_
 150      or fetch it from http://wwwkeys.pgp.net (2649A5A9).
 151
 152   2. Now feed the key into APT by invoking::
 153
 154        apt-key add #file#
 155
 156      Where `#file#` has to be replaced with the location of the key file you just
 157      downloaded. You need to have superuser-privileges to do this (either do it
 158      as root or use sudo).
 159
 160
 161 How can I cite NeuroDebian?
 162   Please cite the following paper:
 163
 164   Halchenko, Y. O. & Hanke, M. (2012). `Open is not enough. Let’s take the
 165   next step: An integrated, community-driven computing platform for neuroscience
 166   <http://www.frontiersin.org/Neuroinformatics/10.3389/fninf.2012.00022/full>`_.
 167   *Frontiers in Neuroinformatics*, 6:22.
 168
 169
 170 .. include:: link_names.txt
 171 .. include:: substitutions.txt
 172
 173 .. raw:: html
 174
 175   <script type="text/javascript">
 176   $('dt').click(function(e){
 177       $(this).nextUntil('dt').toggle();
 178   });
 179   $('dd').hide();
 180   </script>
 181