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   Why is NeuroDebian not a Pure Blend?
  30     This is in the works, but...
  31
  32     There is no need for it to become one, as the existing Debian Pure Blends
  33     already offer the desired functionality *within* Debian. Similar to Pure
  34     Blends, NeuroDebian's goal is to provide software for neuroscientists using
  35     the Debian operating system, and therefore the ultimate goal is to get all
  36     relevant software **into Debian**.
  37
  38     However, various reasons exist that prevent a particular software from
  39     entering Debian. Some are temporary, i.e. a package is already useable, but
  40     some technical bits do not meet Debian's standards (yet) or a licensing issue
  41     needs to be resolved first. For some software the licensing is so restrictive
  42     that it cannot be distributed by Debian, and hence cannot even go into its
  43     *non-free* branch. Unfortunately, sometimes these issues cannot be solved to
  44     a degree that is acceptable for Debian. For some other packages Debian itself
  45     is not ready yet, e.g. huge data packages with neuroscience data (:ref:`with
  46     sometimes over 1GB <pkg_fsl-first-data>`).
  47
  48     NeuroDebian aims to be a platform that provides a staging area for
  49     neuroscience software packages on their way into Debian. All packages are
  50     properly registered in the relevant `Debian Pure Blends`_, e.g.
  51     `Debian Science Cognitive Neuroscience`_ or `Debian Med Imaging`_. Inside
  52     Debian these efforts already provide a suitable framework for this purpose,
  53     and hence there is no need to establish yet another one.
  54
  55   .. _Debian Pure Blends: http://wiki.debian.org/DebianPureBlends
  56   .. _Debian Science Cognitive Neuroscience: http://blends.alioth.debian.org/science/tasks/neuroscience-cognitive
  57   .. _Debian Med Imaging: http://debian-med.alioth.debian.org/tasks/imaging
  58
  59
  60   I want to help. How do I get involved?
  61     We always need people to help maintaining existing packages. If you need
  62     some additional software packaged and you want to try it on your own, we would
  63     be happy to mentor you. We also have a :ref:`list of ongoing and planned
  64     projects <projects>`, each listing a number of tasks that need to be done.
  65
  66     If you found something you are interested in, please email the
  67     neurodebian-devel_ mailing list and let us know about it. Thanks!
  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 certain set of Debian and Ubuntu releases (aka backports).
  83
  84   .. _ITPs: http://www.debian.org/devel/wnpp
  85   .. _pkg-exppsy group on Debian's Alioth server: http://alioth.debian.org/projects/pkg-exppsy/
  86
  87
  88   Debian, Debian, Debian -- What about Ubuntu?
  89     NeuroDebian offers backported binary packages for recent Ubuntu releases
  90     whenever possible. However, since Ubuntu (like many other derivatives) uses
  91     Debian as its foundation, it is more efficient to spend time maintaining
  92     packages in Debian, instead of having to directly contribute to countless
  93     child-distributions.  After the appearance of new packages in Debian, Ubuntu
  94     typically synchronizes them quickly and they become available in the *Ubuntu
  95     universe* -- a repository of Debian packages rebuilt for a particular Ubuntu
  96     release.  We are not constantly rebuilding of all available NeuroDebian
  97     packages for new Ubuntu releases.  Therefore, you might find some packages
  98     temporarily being available for older Ubuntu releases only -- until the point
  99     when a new package version is made and gets built for all currently supported
 100     releases.
 101
 102
 103   How to create a mirror of the repository?
 104     The NeuroDebian repository can be mirrored with rsync. If you are interested
 105     in sponsoring storage space and bandwidth for another mirror, please
 106     `contact us <team@neuro.debian.net>`_.
 107
 108
 109   How do I get a new neuroscience-related FOSS into (Neuro)Debian?
 110     The goal of NeuroDebian is to package neuroscience software for Debian. Hence
 111     getting software into NeuroDebian means trying to get it into Debian. There are
 112     at least two possibilities to achieve that:
 113
 114     * You can approach packaging it yourself. Start by filing an ITP_ (Intent to
 115       package) bugreport) and `ask us <team@neuro.debian.net>`_ to mentor your
 116       upload to Debian_, if you are not a Debian developer.
 117
 118     * `Contact us <team@neuro.debian.net>`_ -- but then it might take a little
 119       longer, depending on our current workload and interest in a particular
 120       software.
 121
 122
 123   I have heard that some packages are non-free. Will you charge me for them?
 124     No. The term :term:`non-free` refers to an archive section. NeuroDebian uses
 125     exactly the same `archive sections as Debian proper
 126     <http://www.debian.org/doc/debian-policy/ch-archive.html>`_.  The *non-free*
 127     section contains packages that have certain restrictions regarding **your
 128     freedom** to employ them for a particular purpose. In contrast, for packages
 129     in the *main* section your are completely free to do whatever and in whatever
 130     context you like. Regardless of the actual license or archive section, all
 131     packages in NeuroDebian are provided free of charge and under the licensing
 132     terms of the original developers.
 133
 134   .. _sec_pkg_authentication:
 135
 136   What means "The following signatures couldn't be verified..."?
 137     When you start using this repository, you probably get warning messages
 138     like this::
 139
 140       The following signatures couldn't be verified because
 141       the public key is not available.
 142
 143     Or you will be asked questions like this over and over::
 144
 145       WARNING: The following packages cannot be authenticated!
 146       ...
 147       Install these packages without verification [y/N]?
 148
 149     This is because your APT installation initially does not know the GPG
 150     key that is used to sign the release files of this repository. It is easy to
 151     make APT happy again. The simplest way is to install the ``neurodebian-keyring``
 152     package that is available from the NeuroDebian repository. Alternatively:
 153
 154     1. Get the key. Either download the `repository key from here
 155        <_static/neuro.debian.net.asc>`_
 156        or fetch it from http://wwwkeys.pgp.net (2649A5A9).
 157
 158     2. Now feed the key into APT by invoking::
 159
 160          apt-key add #file#
 161
 162        Where `#file#` has to be replaced with the location of the key file you just
 163        downloaded. You need to have superuser-privileges to do this (either do it
 164        as root or use sudo).
 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