Open-source release

.gitignore

+*~
+*.swp
+*.pyc
+*.so
+bin
+eggs
+parts
+.installed.cfg
+.mr.developer.cfg
+*.egg-info
+develop-eggs
+sphinx
+doc/api
+src
+dist
+.nfs*
+.gdb_history
+build
+*.egg
+opsnr.stt
+.coverage
+.DS_Store
+html/

.gitlab-ci.yml

+py27-linux:
+  script:
+  - git clean -ffdx
+  - export TMPDIR=/var/tmp
+  - /idiap/project/beat/environments/staging/usr/bin/python bootstrap-buildout.py
+  - ./bin/buildout
+  - ./bin/python --version
+  - unset TMPDIR
+  - cd src/cpulimit && make && cd -
+  - cd bin && ln -s ../src/cpulimit/src/cpulimit . && cd -
+  - export NOSE_WITH_COVERAGE=1
+  - export NOSE_COVER_PACKAGE=beat.core
+  - ./bin/nosetests -sv
+  - ./bin/sphinx-apidoc --separate -d 2 --output=doc/api beat
+  - ./bin/sphinx-build doc html
+  tags:
+  - lidiap2015
+
+py27-macosx:
+  script:
+  - git clean -ffdx
+  - /Users/buildbot/work/environments/beat/py27/bin/python bootstrap-buildout.py
+  - ./bin/buildout
+  - ./bin/python --version
+  - cd src/cpulimit && make && cd -
+  - cd bin && ln -s ../src/cpulimit/src/cpulimit . && cd -
+  - export NOSE_WITH_COVERAGE=1
+  - export NOSE_COVER_PACKAGE=beat.core
+  - ./bin/nosetests -sv
+  - ./bin/sphinx-apidoc --separate -d 2 --output=doc/api beat
+  - ./bin/sphinx-build doc html
+  tags:
+  - beat-macosx

AUTHORS.rst

+.. vim: set fileencoding=utf-8 :
+
+.. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/          ..
+.. Contact: beat.support@idiap.ch                                             ..
+..                                                                            ..
+.. This file is part of the beat.web module of the BEAT platform.             ..
+..                                                                            ..
+.. Commercial License Usage                                                   ..
+.. Licensees holding valid commercial BEAT licenses may use this file in      ..
+.. accordance with the terms contained in a written agreement between you     ..
+.. and Idiap. For further information contact tto@idiap.ch                    ..
+..                                                                            ..
+.. Alternatively, this file may be used under the terms of the GNU Affero     ..
+.. Public License version 3 as published by the Free Software and appearing   ..
+.. in the file LICENSE.AGPL included in the packaging of this file.           ..
+.. The BEAT platform is distributed in the hope that it will be useful, but   ..
+.. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY ..
+.. or FITNESS FOR A PARTICULAR PURPOSE.                                       ..
+..                                                                            ..
+.. You should have received a copy of the GNU Affero Public License along     ..
+.. with the BEAT platform. If not, see http://www.gnu.org/licenses/.          ..
+
+===========================================================
+ Authors of the Biometrics Evaluation and Testing Platform
+===========================================================
+
+Andre Anjos <andre.anjos@idiap.ch>
+Flavio Tarsetti <flavio.tarsetti@idiap.ch>
+Laurent El-Shafey <laurent.el-shafey@idiap.ch>
+Philip Abbet <philip.abbet@idiap.ch>
+Samuel Gaist <samuel.gaist@idiap.ch>
+Sebastien Marcel <sebastien.marcel@idiap.ch>

MANIFEST.in

+include LICENSE.AGPL README.rst buildout.cfg bootstrap-buildout.py
+recursive-include doc conf.py *.rst *.png *.svg *.ico *.odg *.pdf *.dot
+recursive-include beat/core/schema *.json
+recursive-include beat/core/prototypes *.json *.py
+recursive-include beat/core/test/prefix *.json *.py

README.rst

+.. vim: set fileencoding=utf-8 :
+
+.. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/          ..
+.. Contact: beat.support@idiap.ch                                             ..
+..                                                                            ..
+.. This file is part of the beat.core module of the BEAT platform.            ..
+..                                                                            ..
+.. Commercial License Usage                                                   ..
+.. Licensees holding valid commercial BEAT licenses may use this file in      ..
+.. accordance with the terms contained in a written agreement between you     ..
+.. and Idiap. For further information contact tto@idiap.ch                    ..
+..                                                                            ..
+.. Alternatively, this file may be used under the terms of the GNU Affero     ..
+.. Public License version 3 as published by the Free Software and appearing   ..
+.. in the file LICENSE.AGPL included in the packaging of this file.           ..
+.. The BEAT platform is distributed in the hope that it will be useful, but   ..
+.. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY ..
+.. or FITNESS FOR A PARTICULAR PURPOSE.                                       ..
+..                                                                            ..
+.. You should have received a copy of the GNU Affero Public License along     ..
+.. with the BEAT platform. If not, see http://www.gnu.org/licenses/.          ..
+
+
+============================================
+ Biometrics Evaluation and Testing Platform
+============================================
+
+This package contains the source code for the core components of the BEAT
+platform.
+
+Installation
+------------
+
+Really easy, with ``zc.buildout``::
+
+  $ python bootstrap-buildout.py
+  $ ./bin/buildout
+
+These 2 commands should download and install all non-installed dependencies and
+get you a fully operational test and development environment.
+
+.. note::
+
+  The python shell used in the first line of the previous command set
+  determines the python interpreter that will be used for all scripts developed
+  inside this package.
+
+  If you are on the Idiap filesystem, you may use
+  ``/idiap/project/beat/beat.env.deploy/usr/bin/python`` to bootstrap this
+  package instead. It contains the same setup deployed at the final BEAT
+  machinery.
+
+Cpulimit
+========
+
+Make sure the program ``cpulimit`` is available on your system or by the side
+of the python interpreter you bootstrapped as per instructions above. The BEAT
+platform uses this program to control slot usage on the scheduling/worker
+level::
+
+  $ cpulimit -h
+
+If that is not the case, then you need to install it. Either install a package
+that is native to your system (e.g. on Debian or Ubuntu platforms) or compile
+the checked-out version available at ``src/cpulimit``::
+
+  $ cd src/cpulimit;
+  $ make
+  $ ./src/cpulimit -h #to test it
+  $ cd ../../bin #go back to the root of beat.web and the into the `bin' dir
+  $ ln -s ../src/cpulimit/src/cpulimit
+  $ cd .. #go back to the root of beat.web
+
+
+Documentation
+-------------
+
+To build the documentation, just do::
+
+  $ ./bin/sphinx-apidoc --separate -d 2 --output=doc/api beat beat/core/test beat/core/scripts
+  $ ./bin/sphinx-build doc sphinx
+
+
+Testing
+-------
+
+After installation, it is possible to run our suite of unit tests. To do so,
+use ``nose``::
+
+  $ ./bin/nosetests -sv
+
+
+.. note::
+
+   Some of the tests for our command-line toolkit require a running BEAT
+   platform web-server, with a compatible ``beat.core`` installed (preferably
+   the same).  By default, these tests will be skipped. If you want to run
+   them, you must setup a development web server and set the environment
+   variable ``BEAT_CORE_TEST_PLATFORM`` to point to that address. For example::
+
+     $ export BEAT_CORE_TEST_PLATFORM="http://example.com/platform/"
+     $ ./bin/nosetests -sv
+
+   It is **not** adviseable to run tests against a production web server.
+
+If you want to skip slow tests (at least those pulling stuff from our servers)
+or executing lengthy operations, just do::
+
+  $ ./bin/nosetests -sv -a '!slow'
+
+To measure the test coverage, do the following::
+
+  $ ./bin/nosetests -sv --with-coverage --cover-package=beat.core
+
+To produce an HTML test coverage report, at the directory `./htmlcov`, do the
+following::
+
+  $ ./bin/nosetests -sv --with-coverage --cover-package=beat.core --cover-html --cover-html-dir=htmlcov
+
+Our documentation is also interspersed with test units. You can run them using
+sphinx::
+
+  $ ./bin/sphinx -b doctest doc sphinx
+
+
+Development
+-----------
+
+
+Indentation
+===========
+
+You can enforce `PEP8 <https://www.python.org/dev/peps/pep-0008/>` compliance
+using the application ``autopep8``. For example, to enforce compliance on a
+single file and edit it in place, do::
+
+  $ ./bin/autopep8 --indent-size=2 --in-place beat/core/utils.py
+
+We normally use 2-space identattion. If ever, you can easily change the
+identation to 4 spaces like this::
+
+  $ ./bin/autopep8 --indent-size=4 --in-place beat/core/utils.py
+
+
+Profiling
+=========
+
+In order to profile the test code, try the following::
+
+  $ ./bin/python -mcProfile -oprof.data ./bin/nosetests -sv ...
+
+This will dump the profiling data at ``prof.data``. You can dump its contents
+in different ways using another command::
+
+  $ ./bin/python -mpstats prof.data
+
+This will allow you to dump and print the profiling statistics as you may find
+fit.

beat/__init__.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+
+###############################################################################
+#                                                                             #
+# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
+# Contact: beat.support@idiap.ch                                              #
+#                                                                             #
+# This file is part of the beat.core module of the BEAT platform.             #
+#                                                                             #
+# Commercial License Usage                                                    #
+# Licensees holding valid commercial BEAT licenses may use this file in       #
+# accordance with the terms contained in a written agreement between you      #
+# and Idiap. For further information contact tto@idiap.ch                     #
+#                                                                             #
+# Alternatively, this file may be used under the terms of the GNU Affero      #
+# Public License version 3 as published by the Free Software and appearing    #
+# in the file LICENSE.AGPL included in the packaging of this file.            #
+# The BEAT platform is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
+#                                                                             #
+# You should have received a copy of the GNU Affero Public License along      #
+# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
+#                                                                             #
+###############################################################################
+
+#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages
+__import__('pkg_resources').declare_namespace(__name__)

beat/core/__init__.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+
+###############################################################################
+#                                                                             #
+# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
+# Contact: beat.support@idiap.ch                                              #
+#                                                                             #
+# This file is part of the beat.core module of the BEAT platform.             #
+#                                                                             #
+# Commercial License Usage                                                    #
+# Licensees holding valid commercial BEAT licenses may use this file in       #
+# accordance with the terms contained in a written agreement between you      #
+# and Idiap. For further information contact tto@idiap.ch                     #
+#                                                                             #
+# Alternatively, this file may be used under the terms of the GNU Affero      #
+# Public License version 3 as published by the Free Software and appearing    #
+# in the file LICENSE.AGPL included in the packaging of this file.            #
+# The BEAT platform is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
+#                                                                             #
+# You should have received a copy of the GNU Affero Public License along      #
+# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
+#                                                                             #
+###############################################################################

beat/core/baseformat.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+
+###############################################################################
+#                                                                             #
+# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
+# Contact: beat.support@idiap.ch                                              #
+#                                                                             #
+# This file is part of the beat.core module of the BEAT platform.             #
+#                                                                             #
+# Commercial License Usage                                                    #
+# Licensees holding valid commercial BEAT licenses may use this file in       #
+# accordance with the terms contained in a written agreement between you      #
+# and Idiap. For further information contact tto@idiap.ch                     #
+#                                                                             #
+# Alternatively, this file may be used under the terms of the GNU Affero      #
+# Public License version 3 as published by the Free Software and appearing    #
+# in the file LICENSE.AGPL included in the packaging of this file.            #
+# The BEAT platform is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
+#                                                                             #
+# You should have received a copy of the GNU Affero Public License along      #
+# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
+#                                                                             #
+###############################################################################
+
+
+from beat.backend.python.baseformat import *

beat/core/loader.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+
+###############################################################################
+#                                                                             #
+# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
+# Contact: beat.support@idiap.ch                                              #
+#                                                                             #
+# This file is part of the beat.core module of the BEAT platform.             #
+#                                                                             #
+# Commercial License Usage                                                    #
+# Licensees holding valid commercial BEAT licenses may use this file in       #
+# accordance with the terms contained in a written agreement between you      #
+# and Idiap. For further information contact tto@idiap.ch                     #
+#                                                                             #
+# Alternatively, this file may be used under the terms of the GNU Affero      #
+# Public License version 3 as published by the Free Software and appearing    #
+# in the file LICENSE.AGPL included in the packaging of this file.            #
+# The BEAT platform is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
+#                                                                             #
+# You should have received a copy of the GNU Affero Public License along      #
+# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
+#                                                                             #
+###############################################################################
+
+
+from beat.backend.python.loader import *

beat/core/prototypes/__init__.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+
+###############################################################################
+#                                                                             #
+# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
+# Contact: beat.support@idiap.ch                                              #
+#                                                                             #
+# This file is part of the beat.core module of the BEAT platform.             #
+#                                                                             #
+# Commercial License Usage                                                    #
+# Licensees holding valid commercial BEAT licenses may use this file in       #
+# accordance with the terms contained in a written agreement between you      #
+# and Idiap. For further information contact tto@idiap.ch                     #
+#                                                                             #
+# Alternatively, this file may be used under the terms of the GNU Affero      #
+# Public License version 3 as published by the Free Software and appearing    #
+# in the file LICENSE.AGPL included in the packaging of this file.            #
+# The BEAT platform is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
+#                                                                             #
+# You should have received a copy of the GNU Affero Public License along      #
+# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
+#                                                                             #
+###############################################################################
+
+
+'''This module contains prototypes and loading functions for our JSON schemas'''
+
+import pkg_resources
+
+import simplejson
+
+from .. import schema
+
+def load(name):
+  '''Loads a given prototype by name from this directory'''
+
+  fname = pkg_resources.resource_filename(__name__, name + '.json')
+  return schema.validate(name, fname)
+
+def binary_load(name):
+  '''Loads a given prototype by filename in binary mode - no checks'''
+
+  fname = pkg_resources.resource_filename(__name__, name)
+  with open(fname, 'rb') as f: return f.read()

beat/core/prototypes/algorithm.json

+{
+  "language": "unknown",
+  "splittable": false,
+  "groups": [
+    {
+      "name": "main",
+      "inputs": {
+      },
+      "outputs": {
+      }
+    }
+  ],
+  "parameters": {
+  }
+}

beat/core/prototypes/algorithm.py

+class Algorithm:
+
+    def process(self, inputs, outputs):
+
+        # TODO: Implement this algorithm
+
+        return True

beat/core/prototypes/dataformat.json

+{
+}

beat/core/prototypes/library.json

+{
+  "language": "unknown"
+}

beat/core/prototypes/library.py

+# TODO: Implement this library

beat/core/prototypes/plotter.json

+{
+  "dataformat": "plot/unknown/1",
+  "language": "unknown",
+  "parameters": {}
+}

beat/core/prototypes/plotter.py

+class Plotter:
+
+    def process(self, input):
+
+        # TODO: Implement this plotter
+
+        #return image as a string
+        pass

beat/core/prototypes/toolchain.json

+{
+  "blocks": [],
+  "datasets": [],
+  "connections": [],
+  "analyzers": [],
+  "representation": {
+    "connections": {},
+    "blocks": {},
+    "channel_colors": {}
+  }
+}

beat/core/test/.gitignore

+/cache/