ufotest 0.3.1

CLI for setting up ufo camera test station

ufotest

The ufotest project provides a command line interface to install and test the UFO camera, which was developed at the Institute of Data Processing (IPE) of the Karlsruhe Institute of Technology (KIT).

• Free software: MIT license

• Documentation: https://ufotest.readthedocs.io.

Installation

The easiest way to install this package is by using PIP. This will automatically install all the requirements and also register the CLI commands to be usable. (Note that the “sudo” is important to make the commands register correctly within the operating system)

$ sudo pip3 install ufotest
$ ufotest init

Usage

The command line can be accessed through the ufotest command within the console. Use the –help option to display a list of all available commands or consilt the Documentation for a more detailed explanation

$ ufotest --help

Features

• Global configuration file

• Automatic installation of all dependencies for a barebones operation of the UFO camera

Credits

The following software was used in the creation of the project:

• Cookiecutter: A CLI tool for project templating

• audreyr/cookiecutter-pypackage: A basic template for python package projects

History

0.1.0 (2020-08-13)

• First release on PyPI.

0.2.0 (2020-08-23)

• First actual release with content

  • “install” command to install ufotest command automatically

  • “config” command to edit global configuration file

  • “frame” command to acquire and display a single frame

0.3.0 (2020-08-24)

• Added additional package for SUSE which installs c++ compiler

• Fixed unhandled exception in “frame”

• Added additional output if a cmake installation fails

• fixed readme

• Added “init” command, which will setup the installation folder and the config file

0.3.1 (2020-08-25)

• Small adjustments to the documentation

• Added “status.sh” and “reset.sh” scripts from michele to the main code folder.

TODO

• Add a method which checks for init and displays an error message of installation folder has not been initialized

• Add the installation of vivado.

  • Can we add the installer to the repository? If not download using curl

• Execute “setup_camera” and “teardown_camera” scripts before and after acquisition of a frame.

  • I could write a “Camera” context manager object…?

• Make a real help text for the init command

• Add the “init” command to the documentation.