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