sphinx/proj_matlab.rst

   1 .. -*- mode: rst; fill-column: 78 -*-
   2 .. ex: set sts=4 ts=4 sw=4 et tw=79:
   3
   4 .. _project_matlab:
   5
   6 *********************************
   7 Integrating Matlab-based software
   8 *********************************
   9
  10 There is a vast amount of Matlab-based software for neuro-imaging and
  11 psychological research. For various reasons, such software has not been
  12 considered for integration into Debian in the past. However, recent advances of
  13 the Octave_ project allow running a significant number of Matlab tools without
  14 the proprietary environment.
  15
  16 To ease the transition to a completely open-source research environment, we are
  17 following a two-fold approach. On one hand we start packaging all relevant
  18 Octave-compatible software for Debian. On the other hand we work on a proper
  19 integration of (still) Matlab-only software.
  20
  21 The latter shall be achieved by providing a support Debian package that can
  22 represent local Matlab installations to the Debian package management system.
  23 Moreover, this package provides helper tools that ease building MEX extensions
  24 from source during package installation with a local Matlab and therefor allow
  25 for inclusion of such packages into Debian 'contrib' suite (given an appropriate
  26 licence).
  27
  28 The goal is to provide researchers with fully functional Matlab software, that
  29 can be used with Matlab on Debian systems, while benefiting from all advantages
  30 of Debian integration. However, at the same time researchers should have the
  31 possibility to seamlessly switch to Octave_ whenever possible or necessary (e.g.
  32 a laptop being out of reach of a university's license server), and eventually
  33 completely migrate to Octave when full compatibility for a particular software
  34 is achieved.
  35
  36 This effort includes talking to upstream projects about the possibility to run
  37 with Octave, as well as developing patches to achieve such compatibility.
  38
  39 .. _Octave: http://www.gnu.org/software/octave
  40
  41 Status
  42 ------
  43
  44 A :ref:`Matlab-support package <pkg_matlab-support>` draft is ready, available
  45 from NeuroDebian, and has been uploaded to `Debian NEW queue
  46 <http://ftp-master.debian.org/new.html>`_ .
  47
  48 Packaging of individual Matlab-based software has started. This includes
  49 :ref:`SPM <pkg_matlab-spm8>` and :ref:`Fieldtrip <pkg_fieldtrip>` (see
  50 references_ for more packages). Expanding the coverage is planned.
  51
  52 .. todo:: Integrating Matlab-based software
  53
  54    * Finish packaging of fieldtrip which is necessary to complete the packaging
  55      of SPM.
  56    * Create :ref:`matlab-psychtoolbox-3 <pkg_matlab-psychtoolbox-3>` to
  57      complement :ref:`octave-psychtoolbox-3 <pkg_octave-psychtoolbox-3>`.
  58    * Create :ref:`matlab-biosig <pkg_matlab-biosig>` to
  59      complement :ref:`octave-biosig <pkg_octave-biosig>`.
  60    * Package `EEGLAB <http://bugs.debian.org/605739>`_.
  61
  62 .. note:: Done:
  63
  64    * Adapt the packaging of `dynare <http://packages.debian.org/sid/dynare-matlab>`_
  65      in Debian to use the new support package. Once this is done and reviewed by
  66      its maintainers the support package can be submitted for inclusion into
  67      Debian proper.
  68    * Upload :ref:`libgdf <pkg_libgdf-dev>` (including :ref:`matlab-gdf
  69      <pkg_matlab-gdf>`) to Debian proper as soon as :ref:`matlab-support
  70      <pkg_matlab-support>` is accepted
  71
  72 References
  73 ----------
  74
  75 * `SPM packaging progress <http://bugs.debian.org/592390>`_ report.
  76 * `Fieldtrip packaging progress <http://bugs.debian.org/605492>`_ report.
  77 * `EEGLab packaging progress <http://bugs.debian.org/605739>`_ report.
  78 * `PsychToolbox packaging progress <http://bugs.debian.org/606557>`_ report.
  79