Sensor project

Using the project

Installation:

Enter the command: pip install sensor-library-justgo13

Testing code:

cd to C:\Users\USERNAME\AppData\Local\Programs\Python\Python36\Lib\site-packages\sensor_lib

Run library_gui.py to run the GUI.

Reading documentation:

Documentation download

Source Code

Project Github page

Sphinx Documentation

This project was documented using Sphinx with Vim as the text editor. Sphinx creates .rst files when initializing project and Vim is used to open and write to these .rst files. A link to download the version of Vim used in this project can be found here:

Download Vim

Sphinx syntax can be be learned through this resource:

Learn sphinx documentation syntax

To initialize a sphinx documentation project use command: sphinx-quickstart. Make sure to enable autodocs to import auto-generated code. Example of autodoc commands are automodule, autoclass and autofunction.

To build a final project use command make html for html pages and make latex for latex documents.

Jupyter Notebook

This project has a Jupyter notebook to demonstrate the results of the X4 parser and threshold functions as well as the results of running the TI radar parser.

Running Ouster OS1 Lidar

To run the OS1 Lidar, user must have working version of Ubuntu 16.04 or higher. All documentation regarding building and running the Lidar software can be found in the pdf file.

Required libraries

numpy, pandas, webbrowser, tkinter, csv, matplotlib, pymoduleconnector, time, optparse, math