FAQ

FAQ

1. How do I install Centinel?

   • If you just want to run a one off test, then run $ sudo pip install centinel, then $ centinel. This will run your measurement and copy the results to ~/.centinel/results.
   • If you want to participate in the platform, receive new experiments from ICLab, and let researchers at ICLab analyze your results, please use of our install scripts, currently available from https://raw.githubusercontent.com/ben-jones/centinel/add_rpi_install/install/installRPi.sh. The install script will setup Centinel to run and register an account with the server and run all the available experiments once every hour. The install script will schedule a synchronization process that will download new experiments and upload all experiment results once per hour, but this will not work unless you have given your informed consent to do so. For information on how to give the informed consent, please refer to #3 in the FAQ. Once you have given your informed consent, Centinel will start sending results back to ICLab and download experiments every hour.

2. How do I send bug reports?

   Create an issue on GitHub with the log and steps to reproduce it.

3. How do I give my informed consent?

   After installing Centinel, run $ centinel --sync. Doing so will have Centinel create a username and a password and register with the server. After that, run $ centinel --informed-consent. It will give you a URL that you should copy and paste in your browser's address bar. Follow the on-screen instructions in your browser to complete the informed consent process. Once finished, you will be notified if the process has finished successfully.

4. How do I run my own experiments?

   After installing and running Centinel for the first time, a folder will be created at ~/.centinel containing experiment sources and scheduler folder, experiment data files folder, Centinel configuration files, and results folder. Refer to this page on how to create your own experiments: https://github.com/iclab/centinel/wiki/How-to-write-an-experiment-and-run-it-in-Centinel You can install your own experiments by copying source files into ~/.centinel/experiments and placing your experiment data files in ~/.centinel/data. When you run centinel (without arguments), it will run all of the experiments according to scheduler.info. If an experiment is not mentioned in scheduler.info, it will be run every time Centinel is run.

5. Are there sample experiments that I can try out?

   You can use the existing experiments from the centinel repo: https://github.com/iclab/centinel/tree/master/centinel/experiments and sample data inputs from https://github.com/iclab/centinel/tree/master/centinel/data