Skip to content
Snippets Groups Projects

Bob Nightlies

This package is part of the signal-processing and machine learning toolbox Bob. This package implements the so-called "nightlies" aggregator. Its build is triggered every night so all packages are properly recompiled against the latest environment and tested together under that light.

Installation

This package can be built starting from a base development environment, as provided by our from-scratch.sh script. First run it to create a conda-based environment for development. Once the environment is ready, follow the instructions on the .gitlab-ci.yml file to complete the development cycle.

The script build.sh will try to execute the steps from the CI in the right order and can be used to locally test your modifications before pushing a branch into the nightlies, which will trigger a complete set of builds in multiple platforms.

The script build.sh takes several parameters (run it for a help print out):

$ ./build.sh

Updating a Package

Warning

Before adding a package to this prototype, please ensure that the package contains all standard components of a Bob package (README, unit tests, CI integration and documentation among others).

If you don't know how to do this, ask for information on our mailing list.

The new package sits in one of two categories:

  1. If the package belongs to the core of Bob, add the package to the file core.txt, following other packages already inserted. Be attentive to the order in which packages should be compiled.
  2. If the package is not part of the core of Bob, add the package to the file extras.txt, following other packages already inserted. Be attentive to the order in which packages should be compiled.

Once the file is modified, commit the changes to a new branch, with a suggestive name. Push the branch and, once it is green, you may merge it to the master (or ask it to be merged), via a standard merge request.

Contact

For questions or reporting issues to this software package, contact our development mailing list.