Frequently Asked Questions
**************************
+Why NeuroDebian?
+----------------
+
+ In the course of our research endeavors |we| have joined the forces to
+ develop a `PyMVPA -- Python framework for multivariate pattern analysis of
+ neural data <http://www.pymvpa.org>`_. To provide convenient deployment for
+ anyone using Debian-derived distribution this package repository was
+ created. Besides PyMVPA_ project |we| collaborate with `NiPy team
+ <http://neuroimaging.scipy.org>`_ on various projects, such as NiBabel_ and
+ NiPype_. Quickly NeuroDebian_ became our ultimate delivery mechanism for
+ all the projects we develop and package, so they are readily available for
+ deployment.
+
Why is NeuroDebian not a Pure Blend?
------------------------------------
*non-free* branch. Unfortunately, sometimes these issues cannot be solved to
a degree that is acceptable for Debian. For some other packages Debian itself
is not ready yet, e.g. huge data packages with neuroscience data (:ref:`with
- sometimes over 1GB <pkg_fsl-first-data>`)
+ sometimes over 1GB <pkg_fsl-first-data>`).
NeuroDebian aims to be a platform that provides a staging area for
neuroscience software packages on their way into Debian. All packages are
properly registered with the relevant `Debian Pure Blends`_, e.g.
- `Debian-Science Cognitive Neuroscience`_ or `Debian-Med Imaging`_. Inside
+ `Debian Science Cognitive Neuroscience`_ or `Debian Med Imaging`_. Inside
Debian these efforts already provide a suitable framework for this purpose,
and hence there is no need to establish yet another one.
.. _Debian Pure Blends: http://wiki.debian.org/DebianPureBlends
-.. _Debian-Science Cognitive Neuroscience: http://blends.alioth.debian.org/science/tasks/neuroscience-cognitive
-.. _Debian-Med Imaging: http://debian-med.alioth.debian.org/tasks/imaging
+.. _Debian Science Cognitive Neuroscience: http://blends.alioth.debian.org/science/tasks/neuroscience-cognitive
+.. _Debian Med Imaging: http://debian-med.alioth.debian.org/tasks/imaging
When does a package migrate from NeuroDebian into Debian proper?
-----------------------------------------
The NeuroDebian repository can be mirrored with rsync. If you are interested
- in sponsoring storage space and bandwidth for another mirror, please contact
- pkg-exppsy-maintainers@lists.alioth.debian.org.
+ in sponsoring storage space and bandwidth for another mirror, please
+ `contact us <team@neuro.debian.net>`_.
+
+
+How do I get a new neuroscience-related FOSS into (Neuro)Debian?
+----------------------------------------------------------------
+
+ * You can approach packaging it yourself (file an ITP_ (Intent to package)
+ bugreport) and `ask us <team@neuro.debian.net>`_ to mentor your upload to
+ Debian_ if you are not a Debian developer.
+
+ * `Contact us <team@neuro.debian.net>`_, but then it might take longer
+ depending on our workload and interest to the particular software.
+
+.. include:: links_names.rst
+.. include:: substitutions.rst
+.. _welcome:
+
***********************************************
Welcome to the Debian Neuroscience Repository
***********************************************
as root or use sudo).
+.. _chap_installation:
+
+Installation
+============
+
Virtual Machine
-===============
+---------------
+
+If your are not running a Debian_ on a particular machine a :ref:`chap_vm` is
+provided as a convenient testing and evaluation environment. After a
+few simple steps to setup the virtual machine, you will be able to use
+NeuroDebian_ as an integral part of your existing working
+environment without any sacrifice.
+
+
+Debian
+------
+
+Having being exposed to the wonders of NeuroDebian_ you are no longer
+satisfied with your previous choice of operating system? We would
+recommend installing Debian_ to replace or complement (dual-boot) your
+existing OS. Please visit `"Getting Debian"
+<http://www.debian.org/distrib/>`_ to obtain the images for your
+hardware architecture and then simply add |repos|.
+
+
+.. _chap_team:
+
+
+The Team
+========
+
+Our main goal is to provide neuroscience FOSS for Debian_. Thus the
+whole project would not be possible without the work of over 3,000
+Debian_ developers and contributors who are as enthusiastically share
+our goal. To provide our share -- Debian_ packages of FOSS for
+neuroscience research -- `Experimental Psychology Debian packaging
+project <http://alioth.debian.org/projects/pkg-exppsy>`_ was created
+to formally join the forces of
+
+* `Michael Hanke <http://mih.voxindeserto.de>`_
+* `Yaroslav Halchenko <http://www.onerussian.com>`_
+
+Some packages provided within NeuroDebian repository were not packaged
+by our team, but were provided by similar Debian teams. Therefore we
+want to express particular gratitude to `Debian Med`_ and `Debian
+Science`_ teams for making our job easier.
+
+
+Contacts
+========
+
+`Email us <team@neuro.debian.net>`_ if you have any suggestions or
+simply |spread| if you liked it.
+
+.. toctree::
+ :hidden:
+
+ faq
+ pkgs
+ spread
+ vm
+ links_names
+ substitutions
+
+.. probably should be purged altogether
+.. toctree::
+ :hidden:
+
+ livecd
+ gpg
+ setup
-If your are not running a Debian on a particular machine a :ref:`chap_vm` is
-provided as a convenient testing and evaluation environment.
+.. include:: links_names.rst
+.. include:: substitutions.rst
nipy, NIPY, Nipy, etc...
.. _nipy: http://neuroimaging.scipy.org
+.. _nipype: http://nipy.sourceforge.net/nipype
.. _`Brain Imaging Center`: http://bic.berkeley.edu/
.. _dipy: http://nipy.sourceforge.net/dipy
.. _`dipy github`: http://github.com/Garyfallidis/dipy
.. _VTK: http://www.vtk.org/
.. _ITK: http://www.itk.org/
.. _swig: http://www.swig.org
-.. _NeuroDebian: :ref:`welcome`
+.. _NeuroDebian: http://neuro.debian.net
.. _Debian: http://www.debian.org
.. _exppsy: http://alioth.debian.org/projects/pkg-exppsy
+.. _`Debian Med`: http://debian-med.alioth.debian.org
+.. _`Debian Science`: http://wiki.debian.org/DebianScience
.. Functional imaging labs
.. _`functional imaging laboratory`: http://www.fil.ion.ucl.ac.uk
.. Homepages
.. _yoh: http://www.onerussian.com
.. _mih: http://mih.voxindeserto.de
+
+.. Debian specifics
+.. _ITP: http://www.debian.org/devel/wnpp
+.. _ITPs: http://www.debian.org/devel/wnpp
--- /dev/null
+.. _chap_spread:
+
+Spread The Word
+===============
+
+Are you relying on a software packaged by |team| which is part of the
+main Debian_ distribution? Or may be you are relying on the
+NeuroDebian |repos|? Do you think that our efforts to make
+neuroscience FOSS readily available were worthwhile and you think that
+"it is the way to go"? If so, it would benefit you, our project, and
+even the entire neuroscience community if more people become aware of
+Debian_ and NeuroDebian_ in particular. Sharing your positive
+experience with your friends and/or colleagues could be one of the
+ways, alternatively you could...
+
+
+Rate or review
+--------------
+
+NeuroDebian_ is `present on NITRC portal
+<http://www.nitrc.org/projects/neurodebian/>`_. We would greatly
+appreciate if you rate or express you opinion and/or gratitude in a
+review (see "Reviews & Ratings").
+
+
+Reference from your website
+---------------------------
+
+If you or your research group has a web page, we would appreciate
+a reference to NeuroDebian_. You could simply use a pre-generated
+banner by using following HTML code for a corresponding image:
+
+.. image:: _static/fmri_w200.png
+
+::
+
+ <A HREF="http://neuro.debian.net">
+ <IMG SRC="http://neuro.debian.net/_static/fmri_w200.png" border="0" WIDTH="200px" ALT="Enjoy NeuroDebian">
+ </A>
+
+
+.. image:: _static/button_w200.png
+
+::
+
+ <A HREF="http://neuro.debian.net">
+ <IMG SRC="http://neuro.debian.net/_static/button_w200.png" border="0" WIDTH="200px" ALT="Enjoy NeuroDebian">
+ </A>
+
+
+
+.. include:: links_names.rst
+.. include:: substitutions.rst
.. Substitutions for the whole doc tree
-.. |team| replace:: :ref:`chap_team`
-.. |repos| replace:: :ref:`repository_howto`
+.. |team| replace:: :ref:`NeuroDebian team <chap_team>`
+.. |we| replace:: :ref:`we <chap_team>`
+.. |spread| replace:: :ref:`spread the word about NeuroDebian <chap_spread>`
+.. |repos| replace:: :ref:`NeuroDebian repositories <repository_howto>`
+.. |exppsy| replace:: Experimental Psychology